better primitives docs and comments, and some tweaks #30
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
skygering
reviewed
Dec 27, 2023
src/primitives.jl
Outdated
| `apply` applies some function to every geometry matching the `Target` | ||
| GeoInterface trait, in some arbitrarily nested object made up of: | ||
| - `AbstractArray`s | ||
| - Some arbitrary iterables may also work here |
There was a problem hiding this comment.
I am not really sure what this is referring too
There was a problem hiding this comment.
You mean the dot points? They are the types that will be accepted and recursed over by apply.
Maybe I can make that clearer.
There was a problem hiding this comment.
Or you mean the iterables? it doesn't quite sit with the others but anything unknown (no trait and not an AbstractArray) we try to iterate over.
There was a problem hiding this comment.
Okay yeah that makes sense.
There was a problem hiding this comment.
Ok I'll try to work that into the text
|
I did a spell check, but yeah other than my one comment above, I get what it does. Reads pretty well |
|
Happy for it to merge |
rafaqz
commented
Dec 28, 2023
rafaqz
commented
Dec 28, 2023
rafaqz
commented
Dec 28, 2023
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.
@skygering let me know if this makes more sense to you.
Explaining recursive methods is kind of hard, and I write a lot of code like this so I probably don't see how or what is confusing.