Skip to content

Docstring inherit properties#4129

Closed
kvalev wants to merge 6 commits intosphinx-doc:masterfrom
kvalev:docstring-inherit-properties
Closed

Docstring inherit properties#4129
kvalev wants to merge 6 commits intosphinx-doc:masterfrom
kvalev:docstring-inherit-properties

Conversation

@kvalev
Copy link
Copy Markdown
Contributor

@kvalev kvalev commented Oct 8, 2017 •
edited
Loading

Subject: Properties can now inherit the docstring from parent classes

Feature or Bugfix

  • Feature

Purpose

  • In addition to methods and classes, Sphinx can now also inherit the docstring of properties.

Detail

  • The previous pull request used special members that are available only in Python 3.5+ and the property lookup did not work in older Python versions. The code has been made backward compatible with the help of the qualname pip module.

Relates

@tk0miya
Copy link
Copy Markdown
Member

tk0miya commented Oct 21, 2017

Sorry for late response.
Did you mean docstring-inheritance for property does not work with python 2.x? If so, could you add testcase to ensure the fix?

@tk0miya tk0miya added this to the 1.7 milestone Oct 21, 2017
@shimizukawa
Copy link
Copy Markdown
Member

shimizukawa commented Jan 7, 2018

FYI. The code freeze day of 1.7 will come in a week.

Mid of Jan: Feature freeze, Call for translation and release 1.7b1
#4211 (comment)

@tk0miya tk0miya modified the milestones: 1.7, 1.8 Jan 14, 2018
@saimn saimn mentioned this pull request Feb 7, 2018
Closed
@pllim pllim mentioned this pull request Feb 7, 2018
Closed
@tk0miya
Copy link
Copy Markdown
Member

tk0miya commented Jul 22, 2018

Any updates? The 1.8 will be released in this summer. I think it is deadline of this PR.
If you overdue it, this will be rejected because 2.0 will not support old python.

Note: this adds a new dependency. So this should be merged into major release, not minor.

@tk0miya
Copy link
Copy Markdown
Member

tk0miya commented Aug 22, 2018

Now sphinx-1.8 has been feature-freezed. So I determined to reject this.
Thank you for proposal.

@tk0miya tk0miya closed this Aug 22, 2018
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

No one assigned

Labels

extensions:autodoc type:bug

Projects

None yet

Milestone

1.8.0

Development

Successfully merging this pull request may close these issues.

3 participants

@kvalev @tk0miya @shimizukawa