napari / docs

Documentation for napari (other than API docs)

BSD 3-Clause "New" or "Revised" License

9 stars 37 forks source link

Document command ID naming conventions #405

Open lucyleeow opened 2 months ago

lucyleeow commented 2 months ago

References and relevant issues

Follow up from: https://github.com/napari/napari/pull/6777#pullrequestreview-1995993052

Description

Naming conventions. Note the window prefix was noted by Talley: https://github.com/napari/napari/pull/4826/files#r954915004

Open to discussion and changes.

lucyleeow commented 2 months ago

cc @jni @DragaDoncila

DragaDoncila commented 2 months ago

It will be nice to point that commandID should not be updated only because of code refactor. For simplify of reusability.

@Czaki I'm not sure what you mean sorry, can you expand?

jni commented 2 months ago

I think @Czaki is responding to my suggestion that IDs should be a fully qualified Python path. That ties the IDs to implementation details, which is indeed problematic. So I'm open to scrapping that idea and coming up with a different system. Any suggestions?

lucyleeow commented 2 months ago

So I'm open to scrapping that idea and coming up with a different system.

Do you not like the current system, which I think is like this:

<napari/plugin name>.<window (if require GUI)>.<menu name>.<name describing action>