Skip to content

DOC/TST: remove broken sort, several updates, more doctests#2277

Merged
mwtoews merged 1 commit intoshapely:mainfrom
mwtoews:doc-more-doctests-and-updates
Apr 28, 2025
Merged

DOC/TST: remove broken sort, several updates, more doctests#2277
mwtoews merged 1 commit intoshapely:mainfrom
mwtoews:doc-more-doctests-and-updates

Conversation

@mwtoews
Copy link
Copy Markdown
Member

@mwtoews mwtoews commented Apr 11, 2025 •
edited
Loading

There are multiple objectives of this PR:

  • Change CI job to run doctests with Python 3.13, GEOS 3.13.1 and NumPy 2.1.3 (finally makes use of #2200)
  • Add CI checks for the other RST docs, which required some minor refactoring to pass
  • Remove the advanced sorting example from the manual, since this only worked "by accident" until Python 3.13
  • Add a formatting subsection on scientific formatting in WKT, with a bit of re-wording to the "semantic for format specification" section
  • Re-word some of the migration guideline, as shapely 2.0 is now a past release (i.e. no longer "upcoming")

Closes #2251
Closes #2275

@mwtoews mwtoews mentioned this pull request Apr 11, 2025
Closed
@coveralls
Copy link
Copy Markdown

coveralls commented Apr 11, 2025

Pull Request Test Coverage Report for Build 14393104449

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 63 unchanged lines in 2 files lost coverage.
  • Overall coverage decreased (-1.7%) to 86.14%
Files with Coverage Reduction New Missed Lines %
shapely/conftest.py 10 41.94%
shapely/plotting.py 53 13.11%
Totals Coverage Status
Change from base Build 14238979238: -1.7%
Covered Lines: 2660
Relevant Lines: 3088
💛 - Coveralls

@mwtoews mwtoews requested review from jorisvandenbossche and sgillies and removed request for jorisvandenbossche April 13, 2025 21:52
jorisvandenbossche
jorisvandenbossche reviewed Apr 14, 2025
View reviewed changes
docs/migration.rst
>>> line.coords = [(0, 0), (10, 0), (10, 10)]
>>> print(line)
>>> line.coords = [(0, 0), (10, 0), (10, 10)] # doctest: +SKIP
>>> print(line) # doctest: +SKIP
Copy link
Copy Markdown
Member

@jorisvandenbossche jorisvandenbossche Apr 14, 2025

Choose a reason for hiding this comment

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

Would there be a way to skip this entire file, instead of having to add those many individual skips? (in the end, this whole file is a "historical document", which we don't necessarily need to keep working?)

Copy link
Copy Markdown
Member Author

@mwtoews mwtoews Apr 28, 2025

Choose a reason for hiding this comment

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

I investigated some options, and there isn't an easy way to exclude a file (e.g. this one). I found it simpler and easier to skip each of the breaking lines. Note that this markup does not render in the docs (here).

@jorisvandenbossche
Copy link
Copy Markdown
Member

jorisvandenbossche commented Apr 14, 2025

Looks good, thanks!

@mwtoews mwtoews merged commit 13bca35 into shapely:main Apr 28, 2025
49 of 50 checks passed
@mwtoews mwtoews deleted the doc-more-doctests-and-updates branch April 28, 2025 08:58
hillwithsmallfields pushed a commit to hillwithsmallfields/shapely that referenced this pull request Dec 9, 2025
@mwtoews @hillwithsmallfields
DOC/TST: remove broken sort, several updates, more doctests (shapely#…
a05956c 
…2277)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jorisvandenbossche jorisvandenbossche jorisvandenbossche left review comments

@sgillies sgillies Awaiting requested review from sgillies

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2.1.0 produces floating points with scientific notation where 2.0.* didn't Python 3.13: different sorting

3 participants

@mwtoews @coveralls @jorisvandenbossche