Hi Markus, On 10/02/2017 16:40, Markus Geimer wrote:
Hi all,Following up on my proposal for extended package documentation options sent to the list recently [1], I have a question to the community. During the hackathon part of the User Group Meeting, I implemented the proposal (cfr. [2]) for `module help`. Now, the question came up which of the information should also be included in the `whatis` output and how. Would something in key/value style, like Description: Bla bla Usage: More bla Homepage: http://foo.org Documentation: $EBROOTFOO/some/path Documentation: http://some.url Support: supp...@foo.org Contact: Jim Admin Contact: Jane Admin Extensions: ext1-0.1, ext2-42.7 work for the community? Looking forward to your feedback.
I feel this sort of terse key/value style could be useful, but only for single-line info (e.g. homepage, contact, etc.).
For things like 'description' and 'usage', I'm not sure this would be useful or sensible.
So, maybe what you're looking for is some hybrid approach, where aspects like 'description' and 'usage' (and 'examples') are properly fleshed out sections, where all the other info is packed together in an easy to digest (for machines) form, like the key-value style you showed.
In an ideal world, we would have a sensible default output format, and you would support the necessary knobs and dials to tweak the output to your liking. We briefly discussed this with the 'module template' idea, but I suspect this may be a lot of (tedious) work...
K.
Markus [1] https://www.mail-archive.com/easybuild@lists.ugent.be/msg03050.html [2] https://github.com/hpcugent/easybuild-framework/pull/2113 -- Dr. Markus Geimer Juelich Supercomputing Centre Institute for Advanced Simulation Forschungszentrum Juelich GmbH 52425 Juelich, Germany Phone: +49-2461-61-1773 Fax: +49-2461-61-6656 E-Mail: m.gei...@fz-juelich.de WWW: http://www.fz-juelich.de/jsc ------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------ Forschungszentrum Juelich GmbH 52425 Juelich Sitz der Gesellschaft: Juelich Eingetragen im Handelsregister des Amtsgerichts Dueren Nr. HR B 3498 Vorsitzender des Aufsichtsrats: MinDir Dr. Karl Eugen Huthmacher Geschaeftsfuehrung: Prof. Dr.-Ing. Wolfgang Marquardt (Vorsitzender), Karsten Beneke (stellv. Vorsitzender), Prof. Dr.-Ing. Harald Bolt, Prof. Dr. Sebastian M. Schmidt ------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------
