Skip to content

Unify/factorize plugin desscription with sources #187

Description

@bakpaul

Scripts to auto generate the two pages :

Plugins (and only them) have got a method in the init called getModuleDescription that should

  1. Return the same string as the one in the doc (present in the files here) to unify the descriptions.
  2. Might be used to get the description string while generating the files (to factorize)

The first point is straightforward. I don't feel the second one is really wanted because it will introduce a different mechanism for a subpart of the modules (aka only the plugins). So it will only make the scripts more complex and more easily breakable by changes in the sources of SOFA.

WARNING the description should not contain line break, because it might break the table in markdown.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions