Document which PyMotorCAD commands are available for Linux - #811
Document which PyMotorCAD commands are available for Linux #811Caroline-Leak wants to merge 4 commits into
Conversation
| - ``load_results`` | ||
| - ``run_script`` | ||
|
|
||
| Not yet tested commands |
There was a problem hiding this comment.
This is a public repository and documentation. We shouldn't be adding these kind of bits to the docs.
There was a problem hiding this comment.
Also, several of these have been tested, just have varying levels of success.
There was a problem hiding this comment.
Updated the "not available yet in 27R1" list to "Work In Progress" and also moved the "not tested" functions to that list
| - ``export_force_animation`` | ||
| - ``export_results`` | ||
| - ``get_force_frequency_domain_amplitude`` | ||
| - ``get_messages`` |
There was a problem hiding this comment.
I don't think we will be making get_messages available. If a user wants the messages there is either the log file, or the user can pipe the terminal output to their own log, so the function is a bit pointless.
There was a problem hiding this comment.
Thanks, I had a chat with Jack about the naming of these lists, and have also added UI functions to this list
| - ``get_license`` | ||
| - ``get_magnetic_graph_harmonics`` | ||
| .. quit is in review | ||
| - ``quit`` |
There was a problem hiding this comment.
Quit is available, just getting an improvement.
| - ``load_results`` | ||
| - ``run_script`` | ||
|
|
||
| Not yet tested commands |
There was a problem hiding this comment.
Also, several of these have been tested, just have varying levels of success.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #811 +/- ##
==========================================
- Coverage 88.74% 86.89% -1.86%
==========================================
Files 27 27
Lines 4113 4211 +98
==========================================
+ Hits 3650 3659 +9
- Misses 463 552 +89 🚀 New features to boost your workflow:
|
2 participants
Adds a page to the User Guide with a list of which commands are available for Linux for 27R1, which are not available for 27R1 and which have not yet been tested.