Skip to content
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

Fix the unrendered code snippets in the docstrings #668

Merged
merged 4 commits into from
Apr 22, 2024

Conversation

ciaokitty
Copy link
Contributor

Fixes #640

The example code snippets included in the docstrings are now being rendered correctly in the API docs.

ndcube/ndcube.py Outdated Show resolved Hide resolved
@nabobalis nabobalis added No Changelog Entry Needed Skip all changelog checks. backport 2.1 backport 2.2 on-merge: backport to 2.2 labels Apr 22, 2024
@nabobalis nabobalis force-pushed the ciaokitty/fix-docs branch from 4b4b85c to f42d650 Compare April 22, 2024 12:47
@nabobalis nabobalis merged commit 53baf44 into sunpy:main Apr 22, 2024
15 of 18 checks passed
meeseeksmachine pushed a commit to meeseeksmachine/ndcube that referenced this pull request Apr 22, 2024
meeseeksmachine pushed a commit to meeseeksmachine/ndcube that referenced this pull request Apr 22, 2024
@nabobalis
Copy link
Contributor

Thanks for the PR @ciaokitty

nabobalis added a commit that referenced this pull request Apr 22, 2024
…on-2.2

Backport PR #668 on branch 2.2 (Fix the unrendered code snippets in the docstrings)
nabobalis added a commit that referenced this pull request Apr 22, 2024
…on-2.1

Backport PR #668 on branch 2.1 (Fix the unrendered code snippets in the docstrings)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.2 on-merge: backport to 2.2 No Changelog Entry Needed Skip all changelog checks.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Examples in API docs do not render with syntax highlighting
2 participants