Add template to write new modules

[joaomcteixeira]

You are about to submit a new Pull Request. Before continuing, make sure you read the contributing guidelines, and you comply with the following criteria:

• Your PR is about writing documentation for already existing code 🔥

---

• Add a template explaining how to develop a new module.

Please let me know if it is clear or if any information is missing according to your recent experience. Thanks

[codecov-commenter]

Codecov Report

Merging #520 (f38793d) into main (164c4f3) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #520   +/-   ##
=======================================
  Coverage   74.66%   74.66%           
=======================================
  Files         105      105           
  Lines        6926     6926           
=======================================
  Hits         5171     5171           
  Misses       1755     1755           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 164c4f3...f38793d. Read the comment docs.

[rvhonorato]

what happens if you put an import here that tries to import a dependency that is not installed, will it handle the error?

[joaomcteixeira]

Addressed, thanks.

[mgiulini]

I like the chek @rvhonorato implemented in the optint PR #515 . Maybe we can copy it here? commented out of course

[rvhonorato]

Thank you very much for this (:

[joaomcteixeira]

thanks for the review. I have addressed all the issues.

[rvhonorato]

This template should greatly help new developers to add new modules - most likely for the majority of modules nothing will needs to be changed in the core python shell and this template clarifies where things should be added in the module context.

👍🏽

[mgiulini]

I like the chek @rvhonorato implemented in the optint PR #515 . Maybe we can copy it here? commented out of course

[mgiulini]

Good addition indeed, it's going to be useful!

A curiosity: does the check on the choices in the yaml file work?

[joaomcteixeira]

A curiosity: does the check on the choices in the yaml file work?

not yet: #487

I like the chek @rvhonorato implemented in the optint PR #515 . Maybe we can copy it here? commented out of course

what is it?

[sverhoeven]

Works for me, the variables from haddock.modules import modules_category, category_hierarchy dont list the template module and category so my script also does not list them.

[joaomcteixeira]

Works for me, the variables from haddock.modules import modules_category, category_hierarchy dont list the template module and category so my script also does not list them.

Yes, that was my intention. Do you think the template should be listed? I think not because otherwise, users could use it in the workflow, and that makes no sense. Let me know. Cheers.

[sverhoeven]

Works for me, the variables from haddock.modules import modules_category, category_hierarchy dont list the template module and category so my script also does not list them.

Yes, that was my intention. Do you think the template should be listed? I think not because otherwise, users could use it in the workflow, and that makes no sense. Let me know. Cheers.

No it should not be listed, the template is for module contributors, not for module consumers.

[joaomcteixeira]

Perfect 👍 Thanks!