Skip to content

Conversation

@ppinchuk
Copy link
Collaborator

@castelao Anything we should add/change/remove about the text? Also, do we need to move it up to be it's own main section or is it ok under "Miscellaneous"?

I wanted to have a link for the benchmarks easily accessible from the documentation pages.

@ppinchuk ppinchuk added this to the Finalize OSS release milestone Sep 22, 2025
@ppinchuk ppinchuk self-assigned this Sep 22, 2025
@ppinchuk ppinchuk requested a review from castelao as a code owner September 22, 2025 18:48
Copilot AI review requested due to automatic review settings September 22, 2025 18:48
@ppinchuk ppinchuk added documentation Improvements or additions to documentation enhancement Update to logic or general code improvements p-medium Priority: medium labels Sep 22, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation about Rust benchmarks to the developer guide and standardizes docstring formatting across several files. The main purpose is to provide developers with easy access to performance benchmarking information for the Rust-based routing algorithm.

Key changes:

  • Added a new "Rust Benchmarking" section to the developer documentation with a link to benchmark results
  • Standardized docstring formatting by replacing quoted strings with proper reStructuredText code formatting

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/source/dev/README.rst Added new section documenting Rust benchmarks with link to GitHub Pages
revrt/spatial_characterization/zonal.py Updated docstring formatting from quotes to reStructuredText code blocks
revrt/spatial_characterization/stats.py Updated docstring formatting from quotes to reStructuredText code blocks
revrt/spatial_characterization/cli.py Updated docstring formatting from quotes to reStructuredText code blocks
revrt/costs/dry_costs_creator.py Added code block formatting to docstring example

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link
Member

@castelao castelao left a comment

Choose a reason for hiding this comment

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

I think the Miscellaneous is the right place.

Eventually, we might remove it from README, if it gets too large, and have references in the documentation and specific guidance on how to use it in the development.

@castelao castelao merged commit 4410116 into main Sep 23, 2025
21 checks passed
@castelao castelao deleted the pp/bench_link branch September 23, 2025 01:37
github-actions bot pushed a commit that referenced this pull request Sep 23, 2025
* Add link to rust benchmarks to the docs

* Minor formatting change

* Make link work

* Fix docs

* Fix docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement Update to logic or general code improvements p-medium Priority: medium

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants