Skip to content
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

docs: add missing encoder options to documentation #1752

Merged
merged 2 commits into from
Mar 15, 2024

Conversation

jhaeu
Copy link
Contributor

@jhaeu jhaeu commented Mar 15, 2024

For now, at least the encoder options that are in use in our own configs should be explained. But there are more undocumented options, to be documented in the future.

Pull Request Checklist

  • 1. I have rebased the latest version of the main branch into my feature branch and all conflicts
    have been resolved.
  • 2. I have added information about the change/addition to functionality to the CHANGELOG.md file under the
    [Unreleased] heading.
  • 3. I have documented my code using JDocs tags.
  • 4. I have removed unnecessary commented out code, imports and System.out.println statements.
  • 5. I have written JUnit tests for any new methods/classes and ensured that they pass.
  • 6. I have created API tests for any new functionality exposed to the API.
  • 7. If changes/additions are made to the ors-config.json file, I have added these to the ors config documentation
    along with a short description of what it is for, and documented this in the Pull Request (below).
  • 8. I have built graphs with my code of the Heidelberg.osm.gz file and run the api-tests with all test passing
  • 9. I have referenced the Issue Number in the Pull Request (if the changes were from an issue).
  • 10. For new features or changes involving building of graphs, I have tested on a larger dataset
    (at least Germany), and the graphs build without problems (i.e. no out-of-memory errors).
  • 11. For new features or changes involving the graphbuilding process (i.e. changing encoders, updating the
    importer etc.), I have generated longer distance routes for the affected profiles with different options
    (avoid features, max weight etc.) and compared these with the routes of the same parameters and start/end
    points generated from the current live ORS.
    If there are differences then the reasoning for these MUST be documented in the pull request.
  • 12. I have written in the Pull Request information about the changes made including their intended usage
    and why the change was needed.
  • 13. For changes touching the API documentation, I have tested that the API playground renders correctly.

Fixes # .

Information about the changes

  • Key functionality added:
  • Reason for change:

Examples and reasons for differences between live ORS routes, and those generated from this pull request

Required changes to ors config (if applicable)

For now, at least the encoder options that are in use in our own configs should be explained.
But there are more undocumented options, to be documented in the future.
@jhaeu jhaeu added this to the V8 Release milestone Mar 15, 2024
@jhaeu jhaeu self-assigned this Mar 15, 2024
@jhaeu jhaeu requested review from aoles and rabidllama March 15, 2024 12:03
@jhaeu jhaeu marked this pull request as ready for review March 15, 2024 12:05
@koebi koebi merged commit d90a23f into main Mar 15, 2024
48 checks passed
@koebi koebi deleted the docs/add-missing-encoder-options branch March 15, 2024 12:42
selimguvenc pushed a commit to selimguvenc/openrouteservice that referenced this pull request Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

2 participants