Doc string doc improvement #140

samuelvitorsaraiva · 2024-07-24T08:51:11Z

No description provided.

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.

samuelvitorsaraiva · 2024-07-24T08:53:02Z

Documentation improved and some docstring analysed

…eding a device already plugged in.

cynthiabour · 2024-07-25T15:42:00Z

docs/examples/reaction.JPG

change the figure to The Hitchhiker's Guide to Flow Chemistry template

cynthiabour · 2024-07-25T15:48:50Z

docs/api/bronkhorst_EPC/EPC.yml

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.

cynthiabour

Please try to work on the suggestion and review my comments.

cynthiabour · 2024-08-26T06:57:13Z

autosampler.toml

please create a new branch for built autosampler, and merge it back to after testing

autosample was removed

docs/decision.JPG

cynthiabour · 2024-09-26T13:37:29Z

docs/development/foundations/determine_valve.py

why this determine_valve is here?

Answered in the last comment

cynthiabour · 2024-09-26T13:38:52Z

docs/development/foundations/index.md

check the route of code_structure/modules
There is nothing in Foundation/code structure

This only work in the real flowchem package.
What we see in the internet is no the flowchem package.

cynthiabour · 2024-09-26T13:41:23Z

docs/development/foundations/code_structure.JPG

This we might need to discuss it is necessary to provide in documentation or not

cynthiabour · 2024-09-29T14:53:12Z

docs/development/additional/add_device/example_explained.md

+The methods whiten in the component class to access the functionality of the device are built in the main class of 
+the device:
+
+```python


please add more detail explanation on code (big section of code make ppl lost). Please trim the code or use pseudocode in the beginning)

Improved the explanation as requested!

cynthiabour · 2024-09-29T14:54:56Z

docs/development/additional/add_device/example_explained.md

+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)


move to the top will help ppl see the big picture before dive into the real building progress

Improved the explanation as requested!

cynthiabour · 2024-09-29T14:55:35Z

docs/development/additional/add_device/example_explained.md

please try to add more detail and trim the content again

please find suggestions in the same file

cynthiabour · 2024-09-29T14:57:47Z

docs/development/additional/testing.md

+| KPump      | Tests for Azura compact.                               |
+| FakeDevice | Tests for FakeDevice, just an example how tests works. |
+
+```{warning}


warning or important or note?

"Important" match better with the information shown.

cynthiabour · 2024-09-29T15:01:47Z

docs/development/foundations/determine_valve.py

I don't get why this is here and what is this file for?

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)

…ously~

… add example

…wchem

…ier_cooler.py should be included in the dependencies !

samuelvitorsaraiva added 17 commits July 23, 2024 16:57

Spell correction and addition of .idea in the .gitignore

51e3355

Option to build pdf

b468b79

optionally build your docs in additional formats such as PDF

Code line commented which the docstring is build

620f227

Comment which is important to build the files to DocString reference

Add the names in the authorship

93df234

Files to build the docstring in the ReadTheDocs

30d4d77

sphinx-apidoc -o code_structure ../src

Change in the documentation files

b64767c

Spell check Follow the instructions checked Improve aspect to run and add new devices correctly

Add new files in the Doc folder

a1fab7f

Fixed as suggested

73a595f

Removing flowchemgui reference in the doc

b6736cd

Check and correct spell in the doc

beb3a73

Correct the space and some spell in the src

f1813b8

Correct space

7d4953a

Inspect done by python in point out some issues related to the type c…

9cd2439

…hecking If it does not represent a problem, it is ok.

index.md start learning examples devices development api add_device

79a39af

Should be Power, right?

3c65dff

Addition of some information that helps to understand the logic behind

930235b

Follow the patterns of all devices (way which the component is add)

edd1860

samuelvitorsaraiva requested review from JB-Wolf and cynthiabour July 24, 2024 08:51

samuelvitorsaraiva self-assigned this Jul 24, 2024

Change to better suit the standard followed on other devices

7d8f565

samuelvitorsaraiva linked an issue Jul 24, 2024 that may be closed by this pull request

improve documention #134

Open

samuelvitorsaraiva added 5 commits July 24, 2024 17:19

Reorganized the file according to Eric's suggestion.

4c8129e

Add a FakeDevice so the user can quickly start the package without ne…

bab104b

…eding a device already plugged in.

Update the doc conform new FakeDevice implemented

baaf7a3

Adding logic valve documentation to be evaluated

1d0f388

Update valve logic documentation

032c7af

cynthiabour reviewed Jul 25, 2024

View reviewed changes

docs/examples/reaction.JPG Outdated

Copy link

Contributor

cynthiabour Jul 25, 2024

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

cynthiabour reviewed Jul 25, 2024

View reviewed changes

samuelvitorsaraiva and others added 7 commits September 26, 2024 15:54

Improve the picture

d114404

Update abstraction.md

6e0bdab

Improve the picture and emphasize the terms

212535c

The folder content is helpful to the reader understand the example!

f800676

Update conf_file.md

337959e

Update configuration.md

25155d7

I change the order of some detail, please check it is make sense to you.

Update using_api.md

0736ac9

cynthiabour reviewed Sep 29, 2024

View reviewed changes

samuelvitorsaraiva and others added 22 commits September 30, 2024 10:09

"Important" match better with the information shown.

68bf347

Add more detail to the example!

6a01ad1

Move out the example of the tutorial

1f4c9ee

Move out the example of the tutorial - fix cross-references

5f2dd7f

modify the logic of flowchart

ad9d7da

Move the install guide to tutorial

9f64528

Move the install guide to tutorial - cross-reference

cccf1bd

Removing fig about the code explanation - unnecessary

5a69ac0

Replace phrase about abstraction to a better local

c0c3f2d

Reference to the commando to easily access the example!

b6c3611

Reflected change in some directories (nothing change in the files)

b452c06

Remove the duplicate information related to the conf file. I'd give m…

cddea6d

…ore details about the API server (add an example how to use a function)

Correct the toml to match with the fig and remove the term ~asynchron…

bfdf379

…ously~

Updating the kwargs of the knauer and the reference in the realdevice…

fb62bca

… add example

Unnecessary

b879ca5

removing duplicate information

c861a91

Improve the explanation of the example provided

54dff2a

Improve the explanation of the example of the device added in the flo…

ae910b5

…wchem

Correct the space!

a657145

small changes after inspections !

359085a

Removing unnecessary title!

7eeacf5

Another package used in the flowchem\src\flowchem\devices\custom\pelt…

556e855

…ier_cooler.py should be included in the dependencies !

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc string doc improvement #140

Doc string doc improvement #140

samuelvitorsaraiva commented Jul 24, 2024

samuelvitorsaraiva commented Jul 24, 2024

cynthiabour Jul 25, 2024

cynthiabour Jul 25, 2024

cynthiabour left a comment •

edited

Loading

cynthiabour Aug 26, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 26, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 26, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 26, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 29, 2024

samuelvitorsaraiva Oct 1, 2024

cynthiabour Sep 29, 2024

samuelvitorsaraiva Oct 1, 2024

cynthiabour Sep 29, 2024

cynthiabour Sep 29, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 29, 2024

samuelvitorsaraiva Sep 30, 2024

cynthiabour Sep 29, 2024

samuelvitorsaraiva Sep 30, 2024

Doc string doc improvement #140

Are you sure you want to change the base?

Doc string doc improvement #140

Conversation

samuelvitorsaraiva commented Jul 24, 2024

samuelvitorsaraiva commented Jul 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cynthiabour left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cynthiabour left a comment •

edited

Loading