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

Improve kwargs documentation #2719

Open
sergisiso opened this issue Sep 19, 2024 · 0 comments
Open

Improve kwargs documentation #2719

sergisiso opened this issue Sep 19, 2024 · 0 comments

Comments

@sergisiso
Copy link
Collaborator

We had the same problem on the PSyIR Nodes and Symbols kwargs, and the Transformations options which are passed to the super class. I don't like having them duplicated as we never check them when they are updated, or when new arguments added to the subclasses, and would be quite hard to review.

Adding a link to the super() is a good and simple solution (which some IDEs, static type tools may be able to follow).

There is a more complex solution of programmatically modifying the __doc__ to include the BASE.__doc__ or even spit __doc__ to separate the kwargs so that they can be included in the subclass docsting, but this may be over-engineering it, and probably not for this PR.

Originally posted by @sergisiso in #2692 (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