Repository navigation
gh-142349: Document LazyImportType.resolve() method - #156936
encukou merged 2 commits into
Conversation
Sorry, something went wrong.
Documentation build overview19 files changed · ± 19 modified ± Modified |
Sorry, something went wrong.
This comment was marked as resolved.
johnslavik
left a comment
There was a problem hiding this comment.
Hmmm, https://docs.python.org/3.16/reference/simple_stmts.html#lazy doesn't know about types.LazyImportType. Additionally, none of the classes in types have method documentations.
Maybe the right place for this documentation is in https://docs.python.org/3.16/reference/simple_stmts.html#lazy?
Sorry, something went wrong.
|
And https://docs.python.org/3.16/library/types.html#types.LazyImportType doesn't know about https://docs.python.org/3.16/reference/simple_stmts.html#lazy. These guys should talk to each other. |
Sorry, something went wrong.
|
Actually, this belongs to built-in types. Generator (that isn't a builtin name) interface is documented there too. @Viicos can we move this to built-in types? |
Sorry, something went wrong.
|
I think documenting this in types.rst makes more sense; MappingProxyType is also documented there with some methods. |
Sorry, something went wrong.
|
I indeed took MappingProxyType as a precedent when documenting the method. However, it is the only one currently doing so. Maybe we should move the method definitions of MappingProxyType to https://docs.python.org/3/library/stdtypes.html, and ensure this is done for other types (such as lazy imports) in the future? As mentioned, this is already the case for generator-iterators, which has types.GeneratorType without any method documented. I also know the stdlib page is huge and there are plans to split it, so not sure what should be done today. |
Sorry, something went wrong.
|
@encukou, what would you recommend? |
Sorry, something went wrong.
There was a problem hiding this comment.
IMO, eventually this should be in a new builtins section, but, that's not in place now :)
Any of the proposed locations fine; stick with the current version.
And https://docs.python.org/3.16/library/types.html#types.LazyImportType doesn't know about https://docs.python.org/3.16/reference/simple_stmts.html#lazy
The bigger issue is that reference/simple_stmts has a stub that refers to PEP 810 for the “full specification”, while PEP 810 points right back for the “canonical documentation”. The full spec should move to the docs. But that's not for this PR to solve.
Sorry, something went wrong.
I worked on this a while ago! |
Sorry, something went wrong.
Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
|
GH-157296 is a backport of this pull request to the 3.15 branch. |
Sorry, something went wrong.
…) (#157296) Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
…ythonGH-156936) (python#157296) Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com> (cherry picked from commit 8bcee87)
resolve() is referenced several times in PEP 810, but not documented. I believe it would make sense to explicitly document it.
See also #156924.