-
Notifications
You must be signed in to change notification settings - Fork 85
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
Make ETSConfig class documentation visible in the API docs #1688
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little unsure if there are additional consequences of the re-naming of the class, but I think it's fine: anywhere that was using it was likely doing ETSConfig.__class__
which should still work.
Yes, I think it's mostly safe on the basis that the A late thought on the name, before it gets set in stone: would |
I think I prefer |
Renamed. Merging when CI completes. |
This PR provides an alternative to #1669. The goal is to make the ETSConfig docstrings available in the API docs, so that a search for "ETSConfig" in the online documentation gives useful results. To that end, this PR: * Renames the ETSConfig class to ETSConfigType * Keeps the ETSConfig instance the same as before (previously, the created instance shadowed the class) * Updates the main docstrings of ETSConfigType and ETSConfig. There shouldn't be backwards-compatibility concerns with the rename: the ETSConfig class wasn't available before (since it was shadowed by the instance), and the trick of using type(ETSConfig) to get the class will still work. I'm deliberately not exposing ETSConfigType in traits.api, since in most circumstances it shouldn't be used directly (cherry picked from commit 9e4664c)
This PR provides an alternative to #1669. The goal is to make the ETSConfig docstrings available in the API docs, so that a search for "ETSConfig" in the online documentation gives useful results. To that end, this PR: * Renames the ETSConfig class to ETSConfigType * Keeps the ETSConfig instance the same as before (previously, the created instance shadowed the class) * Updates the main docstrings of ETSConfigType and ETSConfig. There shouldn't be backwards-compatibility concerns with the rename: the ETSConfig class wasn't available before (since it was shadowed by the instance), and the trick of using type(ETSConfig) to get the class will still work. I'm deliberately not exposing ETSConfigType in traits.api, since in most circumstances it shouldn't be used directly (cherry picked from commit 9e4664c)
This PR provides an alternative to #1669. The goal is to make the
ETSConfig
docstrings available in the API docs, so that a search forETSConfig
in the online documentation gives useful results.To that end, this PR:
ETSConfig
class toETSConfigFactory
ETSConfig
instance the same as before (previously, the created instance shadowed the class)ETSConfigFactory
andETSConfig
.There shouldn't be backwards-compatibility concerns with the rename: the
ETSConfig
class wasn't available before (since it was shadowed by the instance), and the trick of usingtype(ETSConfig)
to get the class will still work.I'm deliberately not exposing
ETSConfigFactory
intraits.api
, since in most circumstances it shouldn't be used directly.Screenshots: before
and after (only a portion of the docs shown):