Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make the docs more user friendly #950

Merged
merged 1 commit into from Apr 2, 2024
Merged

Conversation

4383
Copy link
Member

@4383 4383 commented Mar 28, 2024

Improve the general index by adding a contribution guide, changelog, etc.

Refactor sections to host various topics and to generate a more sexy table of context which will be more user friendly.

Refactor formatting heading levels.

Make Asyncio warning message reusable and centralized.

Give more visibility to the Asyncio topic.

@@ -1,4 +1,7 @@
# Asyncio compatibility in eventlet
.. _asyncio-compatibility:
Copy link
Member Author

Choose a reason for hiding this comment

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

IMO it is better to move this file in the doc source and at the rst format.

Copy link

codecov bot commented Mar 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56%. Comparing base (7eb208b) to head (b0647b2).

Additional details and impacted files
@@          Coverage Diff          @@
##           master   #950   +/-   ##
=====================================
- Coverage      56%    56%   -1%     
=====================================
  Files          89     89           
  Lines        9767   9767           
  Branches     1819   1819           
=====================================
- Hits         5478   5475    -3     
- Misses       3920   3921    +1     
- Partials      369    371    +2     
Flag Coverage Δ
ipv6 23% <ø> (ø)
py310asyncio 52% <ø> (ø)
py310epolls 53% <ø> (-1%) ⬇️
py310poll 53% <ø> (-1%) ⬇️
py310selects 53% <ø> (-1%) ⬇️
py311asyncio 52% <ø> (-1%) ⬇️
py311epolls 53% <ø> (-1%) ⬇️
py312asyncio 50% <ø> (-1%) ⬇️
py312epolls 51% <ø> (-1%) ⬇️
py37asyncio 50% <ø> (-1%) ⬇️
py37epolls 51% <ø> (-1%) ⬇️
py38asyncio 51% <ø> (-1%) ⬇️
py38epolls 53% <ø> (ø)
py38openssl 51% <ø> (-1%) ⬇️
py38poll 53% <ø> (-1%) ⬇️
py38selects 53% <ø> (-1%) ⬇️
py39asyncio 51% <ø> (-1%) ⬇️
py39dnspython1 51% <ø> (-1%) ⬇️
py39epolls 53% <ø> (-1%) ⬇️
py39poll 53% <ø> (-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.

@4383 4383 requested a review from itamarst March 28, 2024 14:45
@@ -44,6 +44,14 @@ eventlet.hubs.poll module
:undoc-members:
:show-inheritance:

eventlet.hubs.pyevent module
Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean to restore this?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh good catch. I think I forgot to rebase my development branch... Will fix that

Copy link
Contributor

@itamarst itamarst left a comment

Choose a reason for hiding this comment

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

Seems fine other than the pyevent thing.

Improve the general index by adding a contribution guide, changelog, etc.

Refactor sections to host various topics and to generate a more
sexy table of context which will be more user friendly.

Refactor formatting heading levels.

Make Asyncio warning message reusable and centralized.

Give more visibility to the Asyncio topic.
@4383 4383 merged commit c22b896 into eventlet:master Apr 2, 2024
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants