-
Notifications
You must be signed in to change notification settings - Fork 141
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
revisit docstrings and optionally add demo page for public interfaces #986
Comments
Sir, I would be more than happy to contribute to this docs |
Hey Jay 👋🏻,glad to have you here! Yes that's the purpose of this issue. https:/JuliaImages/juliaimages.github.io is where the documentation is and https:/JuliaImages/juliaimages.github.io/blob/source/docs/src/api_comparison.md this is where we compare different packages. Also couple of demonstrations PRs that need to be finished there: https:/JuliaImages/juliaimages.github.io/pulls. |
sir can you tell exactly where do I need to make changes in the docs part |
Sir can you please help me in this I am a bit new to open-source contribution |
I think this being updated would be quite helpful :https:/JuliaImages/juliaimages.github.io/blob/source/docs/src/api_comparison.md |
Before 1.0 release, we'll need to revisit our public interfaces, if necessary, update the docstrings and add potential demos to https://juliaimages.org/stable/examples/. My personal experience is that JuliaImages already have a lot of nice functions, but without proper education, people would not know their existence and would just miss their MATLAB/python correspondings.
This issue is used to track the progress when someone (maybe me) starts the work.
The text was updated successfully, but these errors were encountered: