Closed troelsfr closed 2 years ago
@troelsfr Could you please ensure that all APIs (and also doc comments, but I don't mind if these get gradually updated) follow American standard spelling? While that is not a reflection of who the tool is for, overall it is nicer and less surprising for users to have some consistency across all tools/packages that we maintain.
Sure. I will pick this up on Monday.
On Sat, 26 Feb 2022, 04:11 Bettina Heim, @.***> wrote:
@troelsfr https://github.com/troelsfr Could you please ensure that all APIs (and also doc comments, but I don't mind if these get gradually updated) follow American standard spelling? While that is not a reflection of who the tool is for, overall it is nicer and less surprising for users to have some consistency across all out tools.
— Reply to this email directly, view it on GitHub https://github.com/qir-alliance/qat/pull/58#issuecomment-1051527011, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAEMHDXQGH3D6WUWXIBZZBDU5BAGPANCNFSM5PD27RJQ . You are receiving this because you were mentioned.Message ID: @.***>
Code changes look good, but one thing that took me a while to piece together is that experimental features effectively have two default settings: one default when experimental is not provided and one when it is. The help description of these parameters is a little confusing in that regard, because it describes some parameters as default
true
and it makes it seem as if some experimental features are enabled by default for normal operation. Perhaps some additional text on the--experimental
parameter itself to clarify that any features that are markedEXPERIMENTAL
are disabled if the top level--experimental
param is not provided?
Yes, this is a good suggestion. I will make this change today.
All experimental and non-experimental features are listed in the help section: