Skip to content

Python API documentation grammar and rendering updates#874

Merged
mfisher87 merged 2 commits intogeojupyter:mainfrom
mtaniguchiking:python-api-docs
Aug 23, 2025
Merged

Python API documentation grammar and rendering updates#874
mfisher87 merged 2 commits intogeojupyter:mainfrom
mtaniguchiking:python-api-docs

Conversation

@mtaniguchiking
Copy link
Contributor

@mtaniguchiking mtaniguchiking commented Aug 14, 2025

Description

Small changes to improve verb tense consistency and parameter type rendering.

  1. Past/future conditional verb changed to present simple verb
  2. Docstring type hinting in :param lines removed for consistent rendering (e.g. line 450)

📚 Documentation preview: https://jupytergis--874.org.readthedocs.build/en/874/
💡 JupyterLite preview: https://jupytergis--874.org.readthedocs.build/en/874/lite

@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch mtaniguchiking/jupytergis/python-api-docs

Copy link
Member

@mfisher87 mfisher87 left a comment

Choose a reason for hiding this comment

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

Looks great, thank you Max!

@mfisher87 mfisher87 added the documentation Improvements or additions to documentation label Aug 22, 2025
@github-actions
Copy link
Contributor

Integration tests report: appsharing.space

@mfisher87
Copy link
Member

#888 should fix the build

@mfisher87 mfisher87 merged commit 58bb222 into geojupyter:main Aug 23, 2025
15 of 17 checks passed
mfisher87 pushed a commit to mapninja/jupytergis-docwork that referenced this pull request Aug 28, 2025
* updated verb tense for consistency

* remove docstring type hinting in :param lines for consistent rendering
HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
* updated verb tense for consistency

* remove docstring type hinting in :param lines for consistent rendering
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants