search

guiwitz / napari-sediment

https://guiwitz.github.io/napari-sediment/napari_sediment.html
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Documentation improvements #15

Open aloboa opened 7 months ago

aloboa commented 7 months ago

As a first-time user, I miss some clarifications in the doc:

  1. I might be dumb, but I think that the doc should state how to start the app:

    conda activate napari-sediment
napari

    then select Plugins/napari Sediment/Sediment to get a menu such as the one reproduced in the documentation.

  2. Masks: are greyed parts to be processed or to be masked out?

  3. What is Intensity distribution width in Mask/Auto ?

  4. Procedure to select a point and get the across-bands profile.

Epta13 commented 7 months ago

Thank you for your suggestions. Please note, that we are still in the testing phase and thus the documentation is not yet complete as well as the entire workflow is not properly tested. We are working on it intensively.

aloboa commented 7 months ago

I know and I do appreciate your excellent contribution. Hopefully, my suggestions contribute to letting you get many users through accessible documentation. Maybe you can add a permanent ticket or a category for users to suggest documentation issues (errors, insufficiencies, suggestions, and even contributions).

Epta13 commented 6 months ago

Thank you very much for your appreciation. That's indeed a great idea about the permanent ticket on the documentation improvements as we will likely not be able to constrain everything in detail for sure. Thanks again!

aloboa commented 6 months ago

ok. Any clue for questions 2-4?