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

improve documentation #1116

Merged
merged 42 commits into from
Jan 31, 2024
Merged

improve documentation #1116

merged 42 commits into from
Jan 31, 2024

Conversation

gboeing
Copy link
Owner

@gboeing gboeing commented Jan 23, 2024

This PR:

  • makes sphinx pull documentation param/return types from function signature annotations (via the sphinx-autodoc-typehints package) instead of from docstrings
  • removes the now-redundant param/return type info from the docstrings
  • improves docstring clarity and details throughout package
  • improves docstring capitalization and punctuation
  • minor fixes to adhere to numpy format

You can see the new documentation (in progress) here: https://osmnx--1116.org.readthedocs.build/en/1116/

See also #1106.

@gboeing gboeing mentioned this pull request Jan 23, 2024
13 tasks
Copy link

codecov bot commented Jan 23, 2024

Codecov Report

Attention: 10 lines in your changes are missing coverage. Please review.

Comparison is base (ca2bed0) 97.86% compared to head (6eb380a) 97.95%.
Report is 133 commits behind head on v2.

❗ Current head 6eb380a differs from pull request most recent head a87f667. Consider uploading reports for the commit a87f667 to get more accurate results

Files Patch % Lines
osmnx/plot.py 96.47% 3 Missing ⚠️
osmnx/_osm_xml.py 93.54% 2 Missing ⚠️
osmnx/utils.py 86.66% 2 Missing ⚠️
osmnx/utils_graph.py 92.85% 2 Missing ⚠️
osmnx/speed.py 94.11% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##               v2    #1116      +/-   ##
==========================================
+ Coverage   97.86%   97.95%   +0.08%     
==========================================
  Files          28       25       -3     
  Lines        2531     2343     -188     
==========================================
- Hits         2477     2295     -182     
+ Misses         54       48       -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

osmnx/distance.py Outdated Show resolved Hide resolved
gboeing and others added 14 commits January 26, 2024 21:15
Add a Dependabot configuration that checks once a week if the GitHub Actions are still using the latest version. If not, it opens a PR to update them.

It will open few PRs, since only major versions are specified (like v3), so only on a major release (like v4) it will update and open a PR. This way it helps actively keep GitHub Actions workflows up to date and secure, while minimizing maintenance burden.

See https://docs.github.com/en/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot
Add Dependabot configuration for GitHub Actions updates
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
…ns/checkout-4

Bump actions/checkout from 3 to 4
@gboeing gboeing merged commit 99c86ce into v2 Jan 31, 2024
4 of 5 checks passed
@gboeing gboeing deleted the docs branch January 31, 2024 05:22
@gboeing
Copy link
Owner Author

gboeing commented May 3, 2024

The first pre-release OSMnx v2 beta has been released. Testers needed! See #1123 for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants