Added @Documented to all annotations in org.python.expose.#415
Open
Stewori wants to merge 4 commits intojython:masterfrom
Open
Added @Documented to all annotations in org.python.expose.#415Stewori wants to merge 4 commits intojython:masterfrom
Stewori wants to merge 4 commits intojython:masterfrom
Conversation
Member
Author
Contributor
|
I checked the changes very carefully and could not spot any typos... |
Member
|
Yes to |
jeff5
reviewed
Apr 17, 2026
| * that object. See {@link PyInteger#int_new} for an example of this type of ExposedNew. | ||
| *<p> | ||
| * {@code PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords}. | ||
| * In this case, the method has full responsibility for creating and initiating the object and |
Member
There was a problem hiding this comment.
Suggested change
| * In this case, the method has full responsibility for creating and initiating the object and | |
| * In this case, the method has full responsibility for creating and initialising the object and |
Member
There was a problem hiding this comment.
Except of course now we run into US vs UK English. (I won't object to either.)
jeff5
reviewed
Apr 17, 2026
| * that object. See {@link PyInteger#int_new} for an example of this type of ExposedNew. | ||
| *<p> | ||
| * {@code PyNewWrapper new_, boolean init, PyType subtype, PyObject[] args, String[] keywords}. | ||
| * In this case, the method has full responsibility for creating and initiating the object and |
Member
There was a problem hiding this comment.
Except of course now we run into US vs UK English. (I won't object to either.)
Comment on lines
+27
to
+28
| * @return the base type of this type. Must be another class annotated with {@code ExposedType}. | ||
| * If unspecified, the base is set to {@code object}, or {@code PyObject.class}. |
Member
There was a problem hiding this comment.
If the @return has to be qualified I would probably give the full version in the Javadoc body, and a minimal one in the @return.
Comment on lines
+27
to
+28
| * @return the base type of this type. Must be another class annotated with {@code ExposedType}. | ||
| * If unspecified, the base is set to {@code object}, or {@code PyObject.class}. |
Member
There was a problem hiding this comment.
Suggested change
| * @return the base type of this type. Must be another class annotated with {@code ExposedType}. | |
| * If unspecified, the base is set to {@code object}, or {@code PyObject.class}. | |
| * Return the base type of this type. This must be another class annotated with {@code ExposedType}. | |
| * If not specified (or {@code Object.class} is given), the base is set to Python {@code object}, that is {@code PyObject.class}. | |
| * @return the base type of this type. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #388