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

Confusing class constants docs #1218

Open
ZLLentz opened this issue Apr 16, 2024 · 0 comments
Open

Confusing class constants docs #1218

ZLLentz opened this issue Apr 16, 2024 · 0 comments

Comments

@ZLLentz
Copy link
Member

ZLLentz commented Apr 16, 2024

Current Behavior

For example, https://pcdshub.github.io/pcdsdevices/v8.3.0/generated/pcdsdevices.device.GroupDevice.html#pcdsdevices.device.GroupDevice.needs_parent

This class has a constant class attribute that is a list, and it renders in the docs as the straight repr of this.

needs_parent: list[type[OphydObject]] = [

This isn't really any sort of external API, so it's strange that it exists at all in the docs, but if it is included it should be less confusing.

Expected Behavior

These sorts of constants shouldn't be in the docs, or they should be formatted better.

Context / environment

#1217 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant