Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docgen: Introduce mechanism to define verbosity of output #7

Open
cepsdev opened this issue Jun 16, 2021 · 0 comments
Open

Docgen: Introduce mechanism to define verbosity of output #7

cepsdev opened this issue Jun 16, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@cepsdev
Copy link
Owner

cepsdev commented Jun 16, 2021

We need a general mechanism to control the verbosity of the output written by document modules. e.g. console output triggered by the --pr option.

An interesting approach would be to introduce doc-templates.

Example:

Consider the following state machine definition.

sm{
S;
states{A;B;C;};
t{A;B;};
};

A user might be interested only in the name of the states and not the specific transitions. i.e. he would like a summary in the form:

State Machine S
States:
A, B, C

To achieve this, the user could define a docgen-template:

kind docgen_template; docgen_template DT;
template{
DT;
sm{
states;
};
};

Meaning: Of all top level elements print only sm - elements, and of sm -elements print only states.

@cepsdev cepsdev added the enhancement New feature or request label Jun 16, 2021
@cepsdev cepsdev self-assigned this Jun 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant