-
Notifications
You must be signed in to change notification settings - Fork 15
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
align language used to describe task names within code and documentation #95
Conversation
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
Will need to update worked_examples at some point - potentially these will be reworked a little before June so will leave for this PR.
|
@andrewphilipsmith Think this is good to go (as with the other PR you can ignore all of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Two tiny issues that can be each be dealt with either in the PR or raised as separate issues as you see fit.
only_keep_image_ids : list of str, optional | ||
List of image IDs to keep in the metadata (default is an empty | ||
list, ``[]``). | ||
List of image IDs to keep in the metadata (default is an empty list, ``[]``). | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realise that this change is only a formatting change in the docstring, but I'm not quite sure of the logic of this function.
- I can't see if this is used anywhere. If it is only used as a helper function by users, then ideally, there should be an example in one of the notebooks.
- If it's not used at all then it should be removed.
If it is used, then how does it handle edge cases? Eg
- What happens if both
remove_image_ids
andonly_keep_image_ids
are empty? Does everything get removed or does everything get kept? Which takes precedence? - What happens if both lists contain the same IDs? Does an error/exception get raised to the user?
Either way, these questions should get moved to a separate issue, rather than trying to resolve them here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Made this as an issue (#161).
remove typo (double underscore infront of _add_shape_id)
Summary
As per #82 - Language used to describe the different 'tasks' performed by the mapreader package do not always align between code/documentation/MR paper. This PR focuses on renaming/aligning language used throughout MapReader to ensure ease of use.
Addresses #82
Describe your changes
rename TileServer (class) to TileServerClientSince discussion leading to Issue no#99 we may need further updates to this TileServer class so am leaving for nowChecklist before assigning a reviewer (update as needed)
Reviewer checklist
Please add anything you want reviewers to specifically focus/comment on.