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

DOC: consider adding chapter Known Limitations #1317

Open
remkop opened this issue Feb 1, 2021 · 0 comments
Open

DOC: consider adding chapter Known Limitations #1317

remkop opened this issue Feb 1, 2021 · 0 comments

Comments

@remkop
Copy link
Owner

remkop commented Feb 1, 2021

Follow-up from suggestion by @deining in discussion here: #1297 (comment)

Repeating some key contents:

I reflected on adding a new chapter 22. Known limitations and caveats that list (amongst others) the limitation of nested classes. Despite we have admonitions now in various places, I tend to think this still would be an enhancement to the documentation.

(...) Between "Tips & Tricks" and "Dependency Injection" is probably a good insertion point.
I like short titles, how about just "Known Limitations"?

Some limitations are already documented, like Variable Arity Limitations, Argument Group Limitations, Limitations of Variable Interpolation, default values for annotated fields, interactive positional parameters, Optional Parameter Limitations.

For some of these it may make sense to repeat the content or expand on the content with an example, for other limitations that already have extensive documentation, perhaps we can just link from the new chapter to the existing section.

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

No branches or pull requests

1 participant