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

Add line breaks to long signatures in docs #134

Merged
merged 1 commit into from
Feb 10, 2025
Merged

Add line breaks to long signatures in docs #134

merged 1 commit into from
Feb 10, 2025

Conversation

dstansby
Copy link
Contributor

@dstansby dstansby commented Feb 7, 2025

I'm hoping that this configuration value (see sphinx docs) will improve reability of long signatures like to_multiscales.

@dstansby dstansby changed the title Add line breaks to signatures in docs Add line breaks to long signatures in docs Feb 7, 2025
@dstansby
Copy link
Contributor Author

dstansby commented Feb 7, 2025

Looks to be working: https://ngff-zarr--134.org.readthedocs.build/en/134/apidocs/ngff_zarr/ngff_zarr.to_multiscales.html#ngff_zarr.to_multiscales.to_multiscales

@dstansby dstansby marked this pull request as ready for review February 7, 2025 16:43
thewtex
thewtex approved these changes Feb 10, 2025
View reviewed changes
Copy link
Owner

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

@dstansby thank you!!

@thewtex thewtex merged commit 8dfff77 into thewtex:main Feb 10, 2025
18 checks passed
@dstansby dstansby deleted the patch-1 branch February 11, 2025 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thewtex thewtex thewtex approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dstansby @thewtex