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

refactor: resolved code issues from docs overhaul #1683

Merged
merged 6 commits into from
Feb 9, 2024

Conversation

TheGreatRefrigerator
Copy link
Contributor

@TheGreatRefrigerator TheGreatRefrigerator commented Feb 8, 2024

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: code related commits extracted from the docs overhaul branch , that should be separately done.
  • Reason for change: clean PR

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

Required changes to ors config (if applicable)

@TheGreatRefrigerator TheGreatRefrigerator changed the title Refactor/resolved code issues from docs overhaul refactor: resolved code issues from docs overhaul Feb 8, 2024
@github-actions github-actions bot added refactor and removed refactor labels Feb 8, 2024
jhaeu and others added 6 commits February 8, 2024 15:59
The following configuration options are not supported by GH
anymore and, therefore, are removed from ORS:
- min_one_way_network_size (removed in GH1.0)
- disabling_allowed (removed in GH3.0)
previously accessible at services.isochrones,
the new mapping was set to endpoints.isochrone.
Some settings like statistics_provider or maximum_locations
that are still reading from isochrones could never
take effect like this.

The endpoint property including related methods were refactored
to be 'isochrones' again.
@TheGreatRefrigerator TheGreatRefrigerator force-pushed the refactor/resolved-code-issues-from-docs-overhaul branch from 3004235 to 8c90f96 Compare February 8, 2024 14:59
@github-actions github-actions bot added refactor and removed refactor labels Feb 8, 2024
@github-actions github-actions bot added refactor and removed refactor labels Feb 8, 2024
@github-actions github-actions bot added refactor and removed refactor labels Feb 8, 2024
Copy link
Contributor

@jhaeu jhaeu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jhaeu jhaeu merged commit e7b3bad into main Feb 9, 2024
36 checks passed
@jhaeu jhaeu deleted the refactor/resolved-code-issues-from-docs-overhaul branch February 9, 2024 13:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Awaiting release
Development

Successfully merging this pull request may close these issues.

3 participants