Skip to content

docs: add examples to docstrings#401

Draft
RaczeQ wants to merge 18 commits into
mainfrom
392-add-examples-to-docstrings-in-classes-and-functions
Draft

docs: add examples to docstrings#401
RaczeQ wants to merge 18 commits into
mainfrom
392-add-examples-to-docstrings-in-classes-and-functions

Conversation

@RaczeQ
Copy link
Copy Markdown
Collaborator

@RaczeQ RaczeQ commented Nov 12, 2023

Modules to fill:

  • Embedders
    • Count
    • Contextual Count
    • GeoVeX
    • Gtfs2vec
    • Hex2vec
    • Highway2vec
  • Joiners
    • Intersection
  • Loaders
    • Gtfs
    • Geoparquet
    • OSM Online
    • OSM PBF
    • OSM Tile
    • OSM Way
  • Neighbourhoods
    • Adjacency
    • H3
  • Plotting
  • Regionalizers
    • Administrative Boundary
    • Geocode
    • H3
    • S2
    • Voronoi
  • Geometry
  • H3

@RaczeQ RaczeQ linked an issue Nov 12, 2023 that may be closed by this pull request
@RaczeQ RaczeQ marked this pull request as ready for review November 12, 2023 23:00
@RaczeQ RaczeQ marked this pull request as draft November 12, 2023 23:00
@codecov
Copy link
Copy Markdown

codecov Bot commented Nov 22, 2023

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.67%. Comparing base (ac33edc) to head (e7121fe).
⚠️ Report is 131 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #401      +/-   ##
==========================================
+ Coverage   88.09%   88.67%   +0.57%     
==========================================
  Files          66       66              
  Lines        2932     2932              
==========================================
+ Hits         2583     2600      +17     
+ Misses        349      332      -17     
Flag Coverage Δ
macos-latest-python3.11 88.09% <100.00%> (+0.51%) ⬆️
ubuntu-latest-python3.10 87.99% <100.00%> (+0.57%) ⬆️
ubuntu-latest-python3.11 87.99% <100.00%> (+0.57%) ⬆️
ubuntu-latest-python3.9 87.97% <100.00%> (+0.51%) ⬆️
windows-latest-python3.11 88.16% <100.00%> (+0.57%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@RaczeQ
Copy link
Copy Markdown
Collaborator Author

RaczeQ commented Nov 27, 2023

TODO: incorporate https://docs.pytest.org/en/7.1.x/how-to/doctest.html into testing scripts

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.

Add examples to docstrings in classes and functions

2 participants