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

Reorganize the documentation #153

Closed
timholy opened this issue Jan 27, 2020 · 4 comments
Closed

Reorganize the documentation #153

timholy opened this issue Jan 27, 2020 · 4 comments
Labels
good first issue Would make a good contribution from new contributors

Comments

@timholy
Copy link
Member

timholy commented Jan 27, 2020

This package has some lovely, but long, documentation strings. Starting with Julia 1.5, the REPL will let you choose between brief and extended help. The documentation of this package should be reorganized to take advantage of that structure. PR #151 illustrates what this process might look like.

@timholy timholy added the good first issue Would make a good contribution from new contributors label Jan 27, 2020
@johnnychen94
Copy link
Member

I've proposed a documentation guide months ago based on the style used by @zygmuntszpak
when I was new to Julia JuliaImages/Images.jl#790 Perhaps it's the time to review it?

@timholy timholy mentioned this issue Jan 27, 2020
9 tasks
@Kunz-David
Copy link

Hello,
I was wondering if there is way of viewing the documentation for this package in a HTML version. (Perhaps something exported with Documenter.jl that can be added to the Images.jl package documentation? Or is there a way to generate the docs for this package localy? - here I don't know how I would go about it though.)
I would be fantastic to have some webpage where I can read the docstrings of functions from this package with functional Latex. The Latex parts of the docstrings in Juno aren't human-readable.

I apologise if this isn't the right place to request it or ask for help, I think of a better way.

@timholy
Copy link
Member Author

timholy commented Mar 6, 2020

https://juliaimages.org/stable/, specifically https://juliaimages.org/stable/imagefiltering/ and the API reference in https://juliaimages.org/stable/function_reference/#Image-algorithms-1.

EDIT: if you forget where it is, when searching it's the top hit for "JuliaImages"

@Kunz-David
Copy link

https://juliaimages.org/stable/, specifically https://juliaimages.org/stable/imagefiltering/ and the API reference in https://juliaimages.org/stable/function_reference/#Image-algorithms-1.

EDIT: if you forget where it is, when searching it's the top hit for "JuliaImages"

Thanks for the help. I was looking for the API. Turns out I was just blind :(

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Would make a good contribution from new contributors
Projects
None yet
Development

No branches or pull requests

3 participants