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

In-Code python attribute docs #184

Open
swillisart opened this issue Jun 26, 2023 · 0 comments
Open

In-Code python attribute docs #184

swillisart opened this issue Jun 26, 2023 · 0 comments
Labels
API A core library or procedure that is shared across all integrations. A fundamental component. documentation Improvements or additions to documentation Research Topic of discussion or research. May be a naive idea or incomplete.
Milestone

Comments

@swillisart
Copy link
Owner

From the the python docs:
If a dictionary is used to assign slots, the dictionary keys will be used as the slot names. The values of the dictionary can be used to provide per-attribute docstrings that will be recognised by inspect.getdoc() and displayed in the output of help().

Should update the base library category classes to include these instead of the comments so the UI and code can utilize them both directly as a single source.

@swillisart swillisart added documentation Improvements or additions to documentation API A core library or procedure that is shared across all integrations. A fundamental component. labels Jun 26, 2023
@swillisart swillisart added this to the 2023.3 milestone Jun 26, 2023
@swillisart swillisart added the Research Topic of discussion or research. May be a naive idea or incomplete. label Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API A core library or procedure that is shared across all integrations. A fundamental component. documentation Improvements or additions to documentation Research Topic of discussion or research. May be a naive idea or incomplete.
Projects
Status: Backlog
Development

No branches or pull requests

1 participant