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.

Sign up for GitHub

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

Jump to bottom

[Draft] Standardize doc-strings #59

Merged
merged 10 commits into from
Feb 27, 2024
Merged

[Draft] Standardize doc-strings #59

merged 10 commits into from
Feb 27, 2024

Conversation

elbeejay
Copy link
Contributor

@elbeejay elbeejay commented Feb 23, 2024 •
edited
Loading

PR to close #44

This PR brings the doc-strings all into compliance with the ruff-linter and styles them in the NumPy format.

I believe more changes and refinements to the individual doc-strings will be required, and examples can always be added to the doc-strings. This will be an on-going process as tests are written etc.


Status of doc-string standardization per .py file:

  • calculate_od_raw.py
  • conversion_utils.py
  • core.py
  • fetch_od.py
  • fetch_pois.py
  • __init__.py
  • load_osm.py
  • network_clean.py
  • optimization.py
  • osm_parser.py
  • utils/graphtool.py

@elbeejay elbeejay marked this pull request as ready for review February 24, 2024 15:24
@elbeejay elbeejay requested a review from g4brielvs February 24, 2024 15:24
@g4brielvs g4brielvs merged commit 72f1d3a into main Feb 27, 2024
4 checks passed
@g4brielvs g4brielvs deleted the standardize-doc-strings branch March 6, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@g4brielvs g4brielvs g4brielvs approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Standardize doc-strings
2 participants
@elbeejay @g4brielvs