-
Notifications
You must be signed in to change notification settings - Fork 16
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
example flag style propagation + minor corrections #98
base: main
Are you sure you want to change the base?
Conversation
Should we choose to proceed, here's a probably-not-but-maybe-comprehensive list of replacements on deck. all are booleans unless marked by *:
|
As an example for how the string comparison would work, the comparison could be:
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #98 +/- ##
==========================================
- Coverage 73.41% 73.19% -0.23%
==========================================
Files 77 80 +3
Lines 13908 13459 -449
==========================================
- Hits 10211 9851 -360
+ Misses 3697 3608 -89 ☔ View full report in Codecov by Sentry. |
This is good, we should do this! Personally, I'm not sure we need the Also for the string variables it would be good to |
Consensus is |
@argonaut22 is this one we can sort out for the release? It should also help get rid of some flags inside |
Noting that the conversion of
pari
is near(ish), a consistent flag syntax would be ideal.@speth suggested a convention of
<verb>_<subject>
likeis_laminar
orhas_shaft
for Boolean parameters, PLUS a string-based option selection for parameters that have more options (e.gicool
can beopt_cooling
which will be underengine
). I would also vote to add a prefix for flags, e.g.,flag_is_laminar
, for ease of searching and identification in the codebase.Thoughts/objections on this @everyone (@aditeyashukla @ngomezve @askprash )?
Making sure we all agree before trying to push beyond this sample
HXfun.jl