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

revisit docstrings and optionally add demo page for public interfaces #986

Open
johnnychen94 opened this issue Nov 5, 2021 · 6 comments
Labels
documentation Modifies the documentation.
Milestone

Comments

@johnnychen94
Copy link
Member

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.

@johnnychen94 johnnychen94 added the documentation Modifies the documentation. label Nov 5, 2021
@johnnychen94 johnnychen94 added this to the v1.0 milestone Nov 5, 2021
@Jay-sanjay
Copy link

Sir, I would be more than happy to contribute to this docs
In this I only need to explain the commands and functioning of each function , am I right ??

@ashwani-rathee
Copy link
Member

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.

@Jay-sanjay
Copy link

Screenshot 2023-08-01 082927

@Jay-sanjay
Copy link

sir can you tell exactly where do I need to make changes in the docs part

@Jay-sanjay
Copy link

Sir can you please help me in this I am a bit new to open-source contribution

@ashwani-rathee
Copy link
Member

I think this being updated would be quite helpful :https:/JuliaImages/juliaimages.github.io/blob/source/docs/src/api_comparison.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Modifies the documentation.
Projects
None yet
Development

No branches or pull requests

3 participants