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

Suggestion: rewrite docstrings for usage rather than reference #1024

Closed
cormullion opened this issue Apr 3, 2023 · 4 comments
Closed

Suggestion: rewrite docstrings for usage rather than reference #1024

cormullion opened this issue Apr 3, 2023 · 4 comments

Comments

@cormullion
Copy link

When I want to lookup what the syntax is for a function, I find the REPL experience less than ideal sometimes. For example, I wanted to know what the syntax for padded arrays and borders was:

imagespaddedarray

(etc.)

Perhaps there's a little bit too much purple text for this text to be readable or helpful?

I think it would make sense to move these from the help to the manual.

@timholy
Copy link
Member

timholy commented Apr 4, 2023

Yes, or even # Extended help. See JuliaImages/ImageFiltering.jl#153. I've had that open and tagged as "good first issue" for years, but even though we get thousands of downloads a month people don't seem so interested in stepping forward to help close it.

@cormullion
Copy link
Author

I'd be happy to move that LATEX out of the docstring into the manual, where I think it should go. I'll make a PR and see how it goes.

@ashwanirathee
Copy link
Member

This issue is resolved right or do we face a similar issue elsewhere?

@timholy
Copy link
Member

timholy commented Jun 15, 2023

Seems largely satisfied to me! Thanks again @cormullion for your heroism.

@timholy timholy closed this as completed Jun 15, 2023
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

No branches or pull requests

3 participants