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.

Sign up for GitHub

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

chore(docs): explain -maxdet #1035

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore(docs): explain -maxdet #1035

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/configuration/commandline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make more concise.
Maybe something like "Maximum number of columns displayed in the entity-relationship diagram"

Possibly add default value and default behaviour

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

        boolean showDetailedTables = tables.size() <= config.getMaxDetailedTables();

Only issue is that tables is tables and views.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

schemaspy/src/main/java/org/schemaspy/SchemaAnalyzer.java

Line 358 in 07f5f07

boolean showDetailedTables = tables.size() <= config.getMaxDetailedTables();

[-css fileName]
Use a custom stylesheet. Bundled stylesheet can be extracted from jar(using zip capable tool), path '/layout/schemaSpy.css'
[-desc description]
Expand Down