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

docs: Add docstrings for new location methods #474

Merged
merged 24 commits into from
Oct 4, 2024
Merged

Conversation

rich-iannone
Copy link
Member

@rich-iannone rich-iannone commented Sep 30, 2024

Given that there are now 11 loc classes (new ones added through #341), we need to ensure that there is sufficient documentation for these (addressing #467). We need at least one example in each of their docstrings. And we have to ensure these are all added to the API reference.

Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.84%. Comparing base (641a8d6) to head (591b211).
Report is 28 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #474   +/-   ##
=======================================
  Coverage   87.84%   87.84%           
=======================================
  Files          42       42           
  Lines        4838     4838           
=======================================
  Hits         4250     4250           
  Misses        588      588           

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

@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 17:17 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 17:46 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 18:12 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 18:23 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 18:23 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 18:42 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 18:54 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 19:10 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 21:11 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 September 30, 2024 21:24 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 13:37 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 13:48 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 13:54 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 14:27 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 14:34 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 14:41 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 14:47 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 14:51 Destroyed
@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 15:11 Destroyed
@rich-iannone rich-iannone marked this pull request as ready for review October 1, 2024 15:30
@rich-iannone rich-iannone requested a review from machow October 1, 2024 15:30
@machow
Copy link
Collaborator

machow commented Oct 1, 2024

Yooo this is looking so good!!!!

This is a small thought -- I wonder if changing...

  • from "A location specification for targeting the..."
  • to "Target the.."

might help keep the index a bit punchier. The downside might be the word "location" doesn't get used, but it's in the section description, so may be okay 😬?!

image

@rich-iannone
Copy link
Member Author

^^^ great idea and I made that change!

@github-actions github-actions bot temporarily deployed to pr-474 October 1, 2024 19:16 Destroyed
@machow machow merged commit 58e9663 into main Oct 4, 2024
13 checks passed
@rich-iannone rich-iannone deleted the docs-new-loc-docstrings branch October 4, 2024 16:26
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