Attempt at trait documentation #183
Merged
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
nyurik
reviewed
Dec 27, 2023
There was a problem hiding this comment.
Love it, thanks!!! I think it could mostly be merged as is. One suggestion that might help the novice users - put more of this info in the trait's overall documentation rather than into individual methods. For example, FeatureProcessor doc should explain that its members will be called in the following order (and document the order, with links to the actual methods). Then you don't actually need most of the per-method documentation, apart from parameter documentation.
michaelkirk
reviewed
Dec 30, 2023
Closed
michaelkirk
requested changes
Jan 11, 2024
Co-authored-by: Michael Kirk <[email protected]>
michaelkirk
approved these changes
Feb 9, 2024
|
(As an aside, seems like the merge queue is working 👍) |
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 is relatively a shot in the dark, and I have no idea how much of this is accurate. I'm trying to implement geozero APIs in geoarrow and it's hard to know what I can count on and what I can't.
Closes #182