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

[Improvement] Deeper documentation about asltk usage (examples) #4

Open
acsenrafilho opened this issue Oct 12, 2024 · 0 comments
Open
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@acsenrafilho
Copy link
Member

What is the purpose here

It could be better to show more examples of usage in the documentation.
Add more examples for each reconstuction.py class and also for the utils.py methods.

Adding output images is also interesting (when needed).

Adding more details at classes/methods docstrings (with or without doctest) is also interesting.

@acsenrafilho acsenrafilho added enhancement New feature or request good first issue Good for newcomers labels Oct 12, 2024
@acsenrafilho acsenrafilho self-assigned this Oct 12, 2024
@acsenrafilho acsenrafilho removed their assignment Nov 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant