-
Notifications
You must be signed in to change notification settings - Fork 1
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
Fix api doc issues #164
Fix api doc issues #164
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #164 +/- ##
==========================================
+ Coverage 97.24% 97.34% +0.09%
==========================================
Files 27 27
Lines 2394 2483 +89
==========================================
+ Hits 2328 2417 +89
Misses 66 66 ☔ View full report in Codecov by Sentry. |
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.
This looks good to me! I would wait until @PipKat can do her review before merging this
Always using abbreviations is fine. You can say “in m” if you want, but I’d prefer you put the unit in parentheses like you have done in many other places. For angles, I’d use “in degrees” because it is just so much easier to understand. For temperatures, that is a great question. We are all over the board on this one. I’d just use “in degrees C” (although I like “temperature in C” too. Feel free to use your preference consistently.
From: Peter Krull - ANSYS ***@***.***>
Sent: Monday, November 20, 2023 10:46 AM
To: ansys/pyadditive ***@***.***>
Cc: Kathy Pippert ***@***.***>; Mention ***@***.***>
Subject: Re: [ansys/pyadditive] Fix api doc issues (PR #164)
[External Sender]
@pkrull-ansys commented on this pull request.
________________________________
In src/ansys/additive/core/machine.py<#164 (comment)>:
DEFAULT_LASER_POWER = 195
+ """Default laser power in Watts."""
Thanks! For brevity's sake, I think I'd prefer abbreviations. Is it ok to say in m rather in in meters? Also, for the angles, do I keep it in degrees or in deg? For degrees Celsius, do I drop degrees and use temperature in C?
—
Reply to this email directly, view it on GitHub<#164 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AUHQY2ZOHU4MCRMEMP45XFLYFN3LLAVCNFSM6AAAAAA7QOTB46VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONBQGEZTONRZGA>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
No description provided.