Resolve documentation signature mismatches #1993
Merged
+53
−56
Conversation
This file contains 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
ymekuria
approved these changes
Jan 28, 2025
| @@ -1039,7 +1039,6 @@ super.init(); | |||
|
|
|||
| /** | |||
| * Asynchronously fetches events emitted by this {@link SmartContract} and returns an array of events with their corresponding types. | |||
| * @async | |||
| @@ -836,7 +839,7 @@ class Field { | |||
| * | |||
| * **Important**: If the given `bytes` array is an array of `booleans` or {@link Bool} elements that all are `constant`, the resulting {@link Field} element will be a constant as well. Or else, if the given array is a mixture of constants and variables of {@link Bool} type, the resulting {@link Field} will be a variable as well. | |||
| * | |||
| * @param bytes - An array of {@link Bool} or `boolean` type. | |||
| * @param bits - An array of {@link Bool} or `boolean` type. | |||
There was a problem hiding this comment.
I see what you did here, but the doc comment above says "If the given bytes array is an array of ...". Should we make the comment and @param name consistent?
There was a problem hiding this comment.
Good eye. Yeah, I updated bytes to bits in all cases. Bits seems like the correct word to use here.
Trivo25
approved these changes
Jan 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR resolves two classes of validation warnings from the typedoc build: signature mismatches, and not exported warnings.
Not exported warnings occur in a case like this:
We make liberal use of this pattern, and I don't see a problem with continuing to do so. We would only respect this warning if we were committed to a 100% complete autogenerated o1js reference.