Skip to content

Reword maintenance policy sentences#882

Merged
4383 merged 1 commit intoeventlet:masterfrom
4383:update-sentences
Jan 16, 2024
Merged

Reword maintenance policy sentences#882
4383 merged 1 commit intoeventlet:masterfrom
4383:update-sentences

Conversation

@4383
Copy link
Copy Markdown
Member

@4383 4383 commented Jan 15, 2024

Reword sentences to make them more meaningful, fix typos, remove examples to discourage new usages.

@4383 4383 requested a review from itamarst January 15, 2024 08:58
@4383
Copy link
Copy Markdown
Member Author

4383 commented Jan 15, 2024

@osfrickler: o/ here is the following patches

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 15, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7662654) 55% compared to head (0b32830) 55%.
Report is 1 commits behind head on master.

Additional details and impacted files
@@          Coverage Diff          @@
##           master   #882   +/-   ##
=====================================
  Coverage      55%    55%           
=====================================
  Files          89     89           
  Lines        9837   9844    +7     
  Branches     1828   1831    +3     
=====================================
+ Hits         5414   5419    +5     
- Misses       4054   4056    +2     
  Partials      369    369           
Flag Coverage Δ
ipv6 22% <ø> (+<1%) ⬆️
py310asyncio 51% <ø> (+<1%) ⬆️
py310epolls 52% <ø> (+<1%) ⬆️
py310poll 52% <ø> (+<1%) ⬆️
py310selects 52% <ø> (+<1%) ⬆️
py311asyncio 51% <ø> (+<1%) ⬆️
py311epolls 52% <ø> (+<1%) ⬆️
py312asyncio 49% <ø> (+<1%) ⬆️
py312epolls 50% <ø> (+<1%) ⬆️
py37epolls 50% <ø> (+<1%) ⬆️
py38epolls 52% <ø> (+<1%) ⬆️
py38openssl 51% <ø> (+<1%) ⬆️
py38poll 52% <ø> (+<1%) ⬆️
py38selects 52% <ø> (+<1%) ⬆️
py39dnspython1 51% <ø> (+<1%) ⬆️
py39epolls 52% <ø> (+<1%) ⬆️
py39poll 52% <ø> (+<1%) ⬆️
py39selects 52% <ø> (+<1%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Copy Markdown

@osfrickler osfrickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thx, apply the same changes to doc/index.rst?

README.rst Outdated
those related to the asyncio migration. **Usage in new projects are
discouraged**. **Our goal is to plan the retirement of eventlet** and to give
you ways to move away from eventlet.
Eventlet now follow a new maintenance policy. **Only maintenance for
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

follows

Reword sentences to make them more meaningful, fix typos, remove
examples to discourage new usages.
@4383 4383 force-pushed the update-sentences branch from c21b4d6 to 0b32830 Compare January 15, 2024 10:35
@4383
Copy link
Copy Markdown
Member Author

4383 commented Jan 15, 2024

Thx, apply the same changes to doc/index.rst?

done

@4383 4383 added the doc label Jan 16, 2024
you ways to move away from eventlet.
Eventlet now follows a new maintenance policy. **Only maintenance for
stability and bug fixing** will be provided. **No new features will be
accepted**, except those related to the asyncio migration. **Usages in new
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe "Using eventlet in new projects is discouraged."?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's update this sentence later if really needed.

@4383 4383 merged commit 131651a into eventlet:master Jan 16, 2024
@4383 4383 mentioned this pull request Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants