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.

Sign up for GitHub

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

Jump to bottom

Fix quartodoc yield docstring issues. #143

Open
griff-rees opened this issue Mar 13, 2024 · 1 comment
Open

Fix quartodoc yield docstring issues. #143

griff-rees opened this issue Mar 13, 2024 · 1 comment
Assignees
@griff-rees
Labels
bug Something isn't working documentation Improvements or additions to documentation python python code
Milestone
Post-April Work

Comments

@griff-rees
Copy link
Collaborator

quartodoc seems to fail on Yield portions of docstrings. I've raised a ticket. Currently these are simply commented out via # symbols, so docs render. Example:

clim-recal/python/clim_recal/utils.py

Lines 376 to 378 in 495efe1

#Yields
#------
#A `Path` for each folder in `path`.

@griff-rees griff-rees self-assigned this Mar 13, 2024
@griff-rees griff-rees added the documentation Improvements or additions to documentation label Mar 13, 2024
@griff-rees griff-rees added this to the Post-March Work milestone Mar 13, 2024
@griff-rees griff-rees added bug Something isn't working python python code labels Mar 13, 2024
@griff-rees
Copy link
Collaborator Author

griff-rees commented Sep 8, 2024 •
edited
Loading

The quartodocs ticket machow/quartodoc#338 is now marked todo (fingers crossed...).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@griff-rees griff-rees

Labels
bug Something isn't working documentation Improvements or additions to documentation python python code
Projects
None yet
Milestone
Post-April Work
Development

No branches or pull requests
1 participant
@griff-rees