Directory-specific documentation update #100
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
e-wai
commented
Jan 9, 2021
routemodel/README.md
Outdated
| ## Tests Module | ||
| + `routes.py`: Methods to query Routes endpoint, collecting information on latitude, longitude, maneuver instructions, distance to maneuver, distance, and street | ||
| + `elevations.py`: Methods to query Elevations endpoint, forming an elevation profile from a set of coordinates | ||
| + `speedlimits.py`: Methods to query Routes endpoint, collecting information around speed limit changes. Separate call from `routes.py` due to specific route points constraints. |
There was a problem hiding this comment.
Two things -
- Why are
routes.pyandspeedlimits.pyseparate calls? - What are the constraints around the above 3 points query builders - can we include this in the docs?
There was a problem hiding this comment.
Was it because speedlimits came in from another team so it's not integrated together?
There was a problem hiding this comment.
it's cause they're different API endpoints with different constraints
also cause another member originally coded it as a separate file, but i did keep it that way
There was a problem hiding this comment.
Can we add the information on the specific API constraints to make it clear then? (I don't know what they are)
mdshiozaki
previously approved these changes
Jan 9, 2021
mdshiozaki
approved these changes
Jan 16, 2021
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.
Collection of cleanups and updates around README
It's considering the open PRs in
dynamicsandroutemodelNo update for
batterycelltestingandSOCupdate is limited (should just go with SOC refactor)Lots of reading, sorry