chore(docs): explain -maxdet #1035
Conversation
| @@ -99,7 +99,7 @@ Html report related | |||
| Path to custom mustache template/css directory, needs to contain full set of templates. | |||
| Bundled templates can be found in jar '/layout' and can be extracted with jar tool or any zip capable tool. | |||
| [-maxdet number] | |||
| Limit for when tables should be shown with details. | |||
| Threshold for details in diagrams, increase if you still want details, checked against sum of tables and views. | |||
There was a problem hiding this comment.
Make more concise.
Maybe something like "Maximum number of columns displayed in the entity-relationship diagram"
Possibly add default value and default behaviour
There was a problem hiding this comment.
Since your example is incorrect, there's something wrong with the text or the "option"
Show table/view details(all columns) as long as the sum(tables + views) are lower than this assigned value. Default is 400 i think.
There was a problem hiding this comment.
boolean showDetailedTables = tables.size() <= config.getMaxDetailedTables();
Only issue is that tables is tables and views.
There was a problem hiding this comment.
Yeah, this is definitely not obvious at all. In addition to the question of what details is, what diagrams are we talking about? Compact, large, one degree, two degrees?
I think I need a better understanding of the scenario where we use this, before I can suggest improvements.
There was a problem hiding this comment.
|
The parameter is also described further down in the file. |
|
Hmm, i think the one I changed should be removed. It's related to diagrams not directly to html report |
fixes #957