-
Notifications
You must be signed in to change notification settings - Fork 35
make gufe lowercase in docs #1190
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1190 +/- ##
==========================================
- Coverage 94.15% 92.51% -1.65%
==========================================
Files 141 141
Lines 10588 10588
==========================================
- Hits 9969 9795 -174
- Misses 619 793 +174
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Is this settled? Feels like we need a team wide discussion for this, it can be async. @jthorton @hannahbaumann see OpenFreeEnergy/gufe#508 Perhaps without opening the whole can of worms with naming things, I think really the only change in the PR that really changes the "name" is This is a minor preference, I am okay with |
I thought this was settled (see "visual style" here) But if it's just for the package name, that' s fine by me. |
|
AH--sorry, I thought this was motivated with acronym discussion -- my bad! I would argue then that it should be |
| .. note:: | ||
| We have reproduced API documentation from the `GUFE`_ package here for convenience. | ||
| The GUFE package serves as a foundation layer for openfe, providing abstract base classes and object models, and so might be more useful for developers. | ||
| We have reproduced API documentation from the `gufe`_ package here for convenience. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Probably excessive but we can use a macro to not have to copy and paste this note in two places
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
once we're >2 then I'll bother with a macro?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That sounds like a good metric, see:
https://xkcd.com/1319/
https://xkcd.com/1205/
thanks! the start of sentence thing was ambiguous to me - I like keeping it lowercase. |
|
I agree it is ambiguous and not clearly stated in the spec, so I would say there is an element of interpretation to it. We've got 2 votes now for |
Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
Co-authored-by: Mike Henry <11765982+mikemhenry@users.noreply.github.com>
|
No API break detected ✅ |
|
I'm partial to lowercase or |
while we're addressing this in the gufe docs overhaul, I thought I'd update in openfe docs as well.
Checklist
newsentryDevelopers certificate of origin