Skip to content

Python API documentation grammar and rendering updates #874

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

mtaniguchiking
Copy link

@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

Copy link
Contributor

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

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.

1 participant