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

Fix #7331: autodoc: a cython-function are not recognized as a function #7355

Merged
merged 3 commits into from
Mar 22, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Mar 22, 2020

Feature or Bugfix

  • Bug fix

Purpose

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature extensions:autodoc labels Mar 22, 2020
@tk0miya tk0miya added this to the 3.1.0 milestone Mar 22, 2020
@tk0miya tk0miya marked this pull request as ready for review March 22, 2020 10:08
@tk0miya tk0miya changed the title [WIP] Fix #7331: autodoc: a cython-function are not recognized as a function Fix #7331: autodoc: a cython-function are not recognized as a function Mar 22, 2020
@tk0miya tk0miya added type:bug and removed type:enhancement enhance or introduce a new feature labels Mar 22, 2020
@tk0miya tk0miya modified the milestones: 3.1.0, 3.0.0 Mar 22, 2020
Comment on lines +3 to +4
def foo(*args, **kwargs):
"""Docstring."""
Copy link
Contributor

Choose a reason for hiding this comment

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

Coincidentally, this is the only one passed correctly for functions. All pure Python functions defined in Cython has the same signature, e.g. https://mcsinyx.github.io/palace/html/reference.html#palace.sample_size

The definition of those are here: https://github.com/McSinyx/palace/blob/master/src/palace.pyx#L175

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you for the info. I found my implementation does not work well.

tk0miya added a commit to tk0miya/sphinx that referenced this pull request Mar 31, 2020
tk0miya added a commit that referenced this pull request Mar 31, 2020
Fix #7355: autodoc: a signature of cython-function is not recognized well
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants