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

Yamlize is confounding the Auto-docs #629

Closed
john-science opened this issue Apr 20, 2022 · 0 comments · Fixed by #678
Closed

Yamlize is confounding the Auto-docs #629

john-science opened this issue Apr 20, 2022 · 0 comments · Fixed by #678
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@john-science
Copy link
Member

We have correctly turned off the inherited docstrings in the auto-docs. Except for things that subclass yamlize.Attribute, which are still showing docstrings from their inherited super class:

https://terrapower.github.io/releases/armi/v0.2.3/.apidocs/armi.reactor.blueprints.assemblyBlueprint.html#armi.reactor.blueprints.assemblyBlueprint.AssemblyBlueprint.radialMeshPoints

Essentially, it is showing something like this:

radialMeshPoints
    Represents an attribute of a Python class, and a key/value pair in YAML.
    Variables
            name [str] – name of the attribute within the Python class
            key [str] – name of the attribute within the YAML representation
            [type] – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.
            default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.
            storage_name [str] – '_yamlized_' + name, stored as a separate attribute for speed.

It would be nice if it just said:

radialMeshPoints
    key="radial mesh points"
    type=int
    default=None

Or at least:

radialMeshPoints

@john-science john-science added the documentation Improvements or additions to documentation label Apr 20, 2022
@john-science john-science self-assigned this May 20, 2022
@john-science john-science linked a pull request May 20, 2022 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant