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

autodoc: Add :no-value: option to autoattribute and autodata to suppress the default value of the variable #8424

Merged
merged 6 commits into from
Nov 18, 2020

Conversation

tk0miya
Copy link
Member

@tk0miya tk0miya commented Nov 14, 2020

Feature or Bugfix

  • Feature

Purpose

@tk0miya tk0miya added type:enhancement enhance or introduce a new feature extensions:autodoc labels Nov 14, 2020
@tk0miya tk0miya added this to the 3.4.0 milestone Nov 14, 2020
@ktbarrett
Copy link

Looks good to me. Thanks for this @tk0miya!

marlonjames and others added 4 commits November 15, 2020 14:19
When the :annotation: option is not used, the :novalue: option may be used to remove the value.
This is useful when you want to display the type hint but not the value, and you don't want to specify the annotation manually.
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
@tk0miya
Copy link
Member Author

tk0miya commented Nov 15, 2020

@ktbarrett Thank you for comment. Now I'm waiting for comment from garmin-mjames for a while.

Copy link
Contributor

@marlonjames marlonjames left a comment

Choose a reason for hiding this comment

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

Looks fine to me, thanks for picking this up, I haven't had time recently.
When I look at the Travis build I don't see the new tests.

tests/test_ext_autodoc_autoattribute.py Outdated Show resolved Hide resolved
@tk0miya
Copy link
Member Author

tk0miya commented Nov 17, 2020

When I look at the Travis build I don't see the new tests.

Now we've migrated to GitHub Actions. Travis CI is no longer used.

@tk0miya tk0miya merged commit 68c91b1 into sphinx-doc:3.x Nov 18, 2020
@tk0miya tk0miya deleted the 8222_novalue branch November 18, 2020 13:09
@tk0miya
Copy link
Member Author

tk0miya commented Nov 18, 2020

Merged. Thank you for your all!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
extensions:autodoc type:enhancement enhance or introduce a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants