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

Support for Python coroutines #4847

Closed
wants to merge 3 commits into from
Closed

Conversation

ovekaaven
Copy link

@ovekaaven ovekaaven commented Apr 14, 2018

Subject: Add support for Python coroutines

This feature was proposed in #4777.

I've split the patch I proposed into 3 different changesets, and simplified the autodoc part by putting the async check into the common Documenter.add_directive_header instead of its subclasses, which may or may not be to your liking. I can go back to overriding add_directive_header in the subclasses if you prefer that, but I doubt it makes much practical difference.

@codecov
Copy link

codecov bot commented Apr 14, 2018

Codecov Report

Merging #4847 into master will increase coverage by <.01%.
The diff coverage is 87.5%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4847      +/-   ##
==========================================
+ Coverage   82.15%   82.15%   +<.01%     
==========================================
  Files         289      289              
  Lines       38141    38157      +16     
  Branches     5915     5918       +3     
==========================================
+ Hits        31333    31347      +14     
- Misses       5488     5490       +2     
  Partials     1320     1320
Impacted Files Coverage Δ
sphinx/domains/python.py 76.87% <0%> (-0.32%) ⬇️
sphinx/util/inspect.py 74.09% <100%> (+0.66%) ⬆️
sphinx/ext/autodoc/__init__.py 85.21% <100%> (+0.03%) ⬆️
sphinx/pycode/parser.py 95.73% <100%> (+0.01%) ⬆️
sphinx/__init__.py 57.5% <0%> (-2.5%) ⬇️
sphinx/builders/html.py 82.48% <0%> (+0.11%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1958596...f3591f3. Read the comment docs.

Copy link
Member

@tk0miya tk0miya left a comment

Choose a reason for hiding this comment

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

Sorry for very late reviewing.

LGTM with nits.
Could you add testcase for coroutines please?

@tk0miya
Copy link
Member

tk0miya commented Jul 29, 2018

ping. The feature freeze for Sphinx-1.8 comes soon (see #4986).
So please let me know status of this PR.

I really want to merge this into next release.

@tk0miya tk0miya modified the milestones: 1.8.0, 2.0 Aug 18, 2018
@tk0miya tk0miya modified the milestones: 2.0.0, 2.1.0 Feb 13, 2019
@tk0miya
Copy link
Member

tk0miya commented Apr 23, 2019

Fixed by #6295 instead.
Thank you for your contribution.

@tk0miya tk0miya closed this Apr 23, 2019
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants