search

parallaxsw / OpenSTA

GNU General Public License v3.0
52 stars 23 forks source link

Suggestion: rename `-group_count` and `-endpoint_count` in `report_checks` #126

Open akashlevy opened 1 week ago

akashlevy commented 1 week ago

The naming for -group_count and -endpoint_count in report_checks is a bit unintuitive.

To me, the flag names seem to suggest that -group_count would set the total number of path groups that get reported, and -endpoint_count would set the total number of endpoints that get reported. Instead, -group_count sets the number of paths per path group and -endpoint_count sets the number of paths per endpoint.

I would consider renaming these flags to avoid end user confusion. Perhaps something more explicit like -group_count->-paths_per_group and -endpoint_count->-paths_per_endpoint.

Of course, you would probably want to still accept -group_count and -endpoint_count for backwards-compatibility.

Just a small suggestion. Let me know your thoughts.

parallaxsw commented 1 day ago

I agree the names are terrible. Another option is -group_path_count, -endpoint_path_count.

akashlevy commented 1 day ago

Those names sounds nice to me. Shall I make a PR for this or do you want to take care of it?

parallaxsw commented 1 day ago

go for it

akashlevy commented 1 day ago

I should still allow -group_count and -endpoint_count for backwards compatibility, right?

parallaxsw commented 18 hours ago

Right; add warnings for them (grep deprecated /.tcl for examples)