Skip to content

Comments

rasterio.coords.BoundingBox: fix attribute docs#3351

Merged
snowman2 merged 2 commits intorasterio:mainfrom
adamjstewart:rasterio/coords
Sep 7, 2025
Merged

rasterio.coords.BoundingBox: fix attribute docs#3351
snowman2 merged 2 commits intorasterio:mainfrom
adamjstewart:rasterio/coords

Conversation

@adamjstewart
Copy link
Contributor

@adamjstewart adamjstewart commented May 21, 2025 •
edited
Loading

Resolves the following warnings in RtD CI:

/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3350/lib/python3.11/site-packages/rasterio/coords.py:docstring of rasterio.coords.BoundingBox.bottom:1: WARNING: duplicate object description of rasterio.coords.BoundingBox.bottom, other instance in api/rasterio.coords, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3350/lib/python3.11/site-packages/rasterio/coords.py:docstring of rasterio.coords.BoundingBox.left:1: WARNING: duplicate object description of rasterio.coords.BoundingBox.left, other instance in api/rasterio.coords, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3350/lib/python3.11/site-packages/rasterio/coords.py:docstring of rasterio.coords.BoundingBox.right:1: WARNING: duplicate object description of rasterio.coords.BoundingBox.right, other instance in api/rasterio.coords, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3350/lib/python3.11/site-packages/rasterio/coords.py:docstring of rasterio.coords.BoundingBox.top:1: WARNING: duplicate object description of rasterio.coords.BoundingBox.top, other instance in api/rasterio.coords, use :no-index: for one of them

Before

Screenshot 2025-05-21 at 12 48 23 PM

After

Screenshot 2025-05-21 at 12 51 53 PM

@snowman2
Copy link
Member

snowman2 commented May 21, 2025

Thoughts about this strategy instead: https://stackoverflow.com/a/20573384

@adamjstewart
Copy link
Contributor Author

adamjstewart commented May 21, 2025

The comments seem to suggest that this faces many of the same problems that this PR is designed to solve, but I'm happy to try it and see.

@snowman2
Copy link
Member

snowman2 commented May 21, 2025

The comments seem to suggest that this faces many of the same problems that this PR is designed to solve, but I'm happy to try it and see.

Yes, I was thinking that it was a different issue you are solving after posting the suggestion. No worries about trying it out.

snowman2
snowman2 reviewed May 21, 2025
View reviewed changes
snowman2
snowman2 approved these changes May 21, 2025
View reviewed changes
Copy link
Member

@snowman2 snowman2 left a comment

Choose a reason for hiding this comment

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

Thanks @adamjstewart 👍

@adamjstewart
Copy link
Contributor Author

adamjstewart commented May 30, 2025

@snowman2 @sgillies ready to merge?

@adamjstewart
Copy link
Contributor Author

adamjstewart commented Jun 5, 2025

Ping

@snowman2
Copy link
Member

snowman2 commented Jun 5, 2025

This is one I would like to hear @sgillies opinion on. The result is what we want, but the syntax is interesting.

@adamjstewart
Copy link
Contributor Author

adamjstewart commented Jun 19, 2025

@sgillies?

@adamjstewart adamjstewart mentioned this pull request Aug 1, 2025
Merged
@snowman2 snowman2 merged commit b82c6a3 into rasterio:main Sep 7, 2025
7 of 22 checks passed
@adamjstewart adamjstewart deleted the rasterio/coords branch September 7, 2025 06:33
@snowman2 snowman2 added documentation backport-1.4 To be backported to maint-1.4 labels Nov 6, 2025
@snowman2 snowman2 added this to the 1.4.4 milestone Nov 6, 2025
snowman2 pushed a commit that referenced this pull request Nov 6, 2025
@adamjstewart @snowman2
rasterio.coords.BoundingBox: fix attribute docs (#3351)
02790e3 
* rasterio.coords.BoundingBox: fix attribute docs

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

Reviewers

@snowman2 snowman2 snowman2 approved these changes

Assignees

No one assigned

Labels

backport-1.4 To be backported to maint-1.4 documentation

Projects

None yet

Milestone

1.4.4

Development

Successfully merging this pull request may close these issues.

2 participants

@adamjstewart @snowman2