Skip to content

Comments

rasterio.enums.Resampling: fix enum docs#3352

Merged
snowman2 merged 3 commits intorasterio:mainfrom
adamjstewart:rasterio/enums
Sep 7, 2025
Merged

rasterio.enums.Resampling: fix enum docs#3352
snowman2 merged 3 commits intorasterio:mainfrom
adamjstewart:rasterio/enums

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/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.average:1: WARNING: duplicate object description of rasterio.enums.Resampling.average, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.bilinear:1: WARNING: duplicate object description of rasterio.enums.Resampling.bilinear, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.cubic:1: WARNING: duplicate object description of rasterio.enums.Resampling.cubic, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.cubic_spline:1: WARNING: duplicate object description of rasterio.enums.Resampling.cubic_spline, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.gauss:1: WARNING: duplicate object description of rasterio.enums.Resampling.gauss, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.lanczos:1: WARNING: duplicate object description of rasterio.enums.Resampling.lanczos, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.max:1: WARNING: duplicate object description of rasterio.enums.Resampling.max, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.med:1: WARNING: duplicate object description of rasterio.enums.Resampling.med, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.min:1: WARNING: duplicate object description of rasterio.enums.Resampling.min, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.mode:1: WARNING: duplicate object description of rasterio.enums.Resampling.mode, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.nearest:1: WARNING: duplicate object description of rasterio.enums.Resampling.nearest, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.q1:1: WARNING: duplicate object description of rasterio.enums.Resampling.q1, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.q3:1: WARNING: duplicate object description of rasterio.enums.Resampling.q3, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.rms:1: WARNING: duplicate object description of rasterio.enums.Resampling.rms, other instance in api/rasterio.enums, use :no-index: for one of them
/home/docs/checkouts/readthedocs.org/user_builds/rasterio/conda/3351/lib/python3.11/site-packages/rasterio/enums.py:docstring of rasterio.enums.Resampling.sum:1: WARNING: duplicate object description of rasterio.enums.Resampling.sum, other instance in api/rasterio.enums, use :no-index: for one of them

Before

Screenshot 2025-05-21 at 1 00 26 PM

After

Screenshot 2025-05-21 at 1 20 51 PM

@adamjstewart adamjstewart marked this pull request as draft May 21, 2025 11:11
@adamjstewart adamjstewart marked this pull request as ready for review May 21, 2025 11:21
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.

Thank @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

Want to hear @sgillies opinion on the syntax.

@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 e2b32df into rasterio:main Sep 7, 2025
7 of 22 checks passed
@adamjstewart adamjstewart deleted the rasterio/enums branch September 7, 2025 06:34
@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.enums.Resampling: fix enum docs (#3352)
5d6d917 
* rasterio.enums.Resampling: fix enum docs

* Fix enum name

* Inline documentation
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