-
Notifications
You must be signed in to change notification settings - Fork 5
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
Doc string doc improvement #140
base: main_all_merged
Are you sure you want to change the base?
Conversation
optionally build your docs in additional formats such as PDF
Comment which is important to build the files to DocString reference
sphinx-apidoc -o code_structure ../src
Spell check Follow the instructions checked Improve aspect to run and add new devices correctly
…hecking If it does not represent a problem, it is ok.
Documentation improved and some docstring analysed |
…eding a device already plugged in.
docs/examples/reaction.JPG
Outdated
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.
change the figure to The Hitchhiker's Guide to Flow Chemistry template
docs/api/bronkhorst_EPC/EPC.yml
Outdated
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.
If it was automatically generated and will be generated again, please don't comment it.
I change the order of some detail, please check it is make sense to you.
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.
Please try to work on the suggestion and review my comments.
autosampler.toml
Outdated
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.
please create a new branch for built autosampler, and merge it back to after testing
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.
autosample was removed
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.
why this determine_valve is here?
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.
Answered in the last comment
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.
check the route of code_structure/modules
There is nothing in Foundation/code structure
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 only work in the real flowchem package.
What we see in the internet is no the flowchem package.
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 we might need to discuss it is necessary to provide in documentation or not
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.
Removed
The methods whiten in the component class to access the functionality of the device are built in the main class of | ||
the device: | ||
|
||
```python |
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.
please add more detail explanation on code (big section of code make ppl lost). Please trim the code or use pseudocode in the beginning)
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.
Improved the explanation as requested!
To better understand the information flow in this class, consider the scenario where an infuse command is sent to the | ||
pump, as illustrated below. | ||
|
||
![](command_flow.JPG) |
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.
move to the top will help ppl see the big picture before dive into the real building progress
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.
Improved the explanation as requested!
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.
please try to add more detail and trim the content again
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.
please find suggestions in the same file
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.
Done!
| KPump | Tests for Azura compact. | | ||
| FakeDevice | Tests for FakeDevice, just an example how tests works. | | ||
|
||
```{warning} |
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.
warning or important or note?
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.
"Important" match better with the information shown.
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.
I don't get why this is here and what is this file for?
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 is the file that @JB-Wolf created to help the user build the valve. I put it here because it is close to the valve logic explanation, and I cite it in this instructions file.
…ore details about the API server (add an example how to use a function)
…ier_cooler.py should be included in the dependencies !
No description provided.