aidge#199: Add documentation for Node

aidge#199 (closed)

Context

update doc API NOde

Modified files

• Node.hpp: several doxygen descriptions have been updated
• pybind_node.cpp: several descriptions have been changed

Detailed major modifications

TODO

marked the checklist item DONE as incomplete

changed target branch from main to dev

added 1 commit

• 1f86559c - continuation

Compare with previous version

added 1 commit

• 9908fb4e - correct merge mistakes

Compare with previous version

added 1 commit

• 8b1c7ae9 - put back node description

Compare with previous version

added 1 commit

• 8fbd0b96 - forw back

Compare with previous version

resolved all threads

added 1 commit

• 913cbd6f - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

assigned to @operrin

added 1 commit

• 8bfcd56d - correct createUniqueName description

Compare with previous version

added 1 commit

• 1129b1b5 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• eb4247e2 - add repr

Compare with previous version

@operrin I am sorry I cannot make a full review of your MR as I don't really have time.

Overall you are doing a good job!

Just two remarks:

• Please try to check implementation to verify the behavior of already documented function. Sadly not all of them are up to date
• When writing documentation I think you should try to focus on conveying the usage instead of describing what it does. On this note it would be nice to also add in the documentation behavior in edge cases. An example that come in mind is describing what happen when removing Parent at an unconnected index. This can be really hard to do but will greatly improve documentation level!

requested review from @cmoineau

Also maybe you can update the description of the MR to put a link to the issue

(Since adding the issue id in the title doesn't link it)

added 1 commit

• 84392b24 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• cdc8e47d - first batch PR

Compare with previous version

added 1 commit

• f0cd8d6a - more updates

Compare with previous version

changed the description

added 1 commit

• f7f0430e - more hpp starting pyhthon bind

Compare with previous version

added 1 commit

• fca46a53 - update hpp and pybind

Compare with previous version

added 1 commit

• 4370ca18 - lil'bit

Compare with previous version

added 1 commit

• 18078cb9 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 1478c91b - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 5b9fe978 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• bf234532 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 67a97069 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

resolved all threads

marked the checklist item TO DO as completed

marked the checklist item NOT DONE as completed

added 1 commit

• ac43550e - do some todoes

Compare with previous version

added 1 commit

• edcce7ff - aidge#199 (closed): update user guide of Node

Compare with previous version

changed the description

added 114 commits

• edcce7ff...40b8dddd - 113 commits from branch eclipse/aidge:dev
• 479326e4 - aidge#199 (closed): update user guide of Node

Compare with previous version

added 12 commits

• 479326e4...f4437b4d - 11 commits from branch eclipse/aidge:dev
• f1fa102d - aidge#199 (closed): update user guide of Node

Compare with previous version

marked this merge request as ready

added 1 commit

• c33a907a - last minute corrections

Compare with previous version

added 4 commits

• c33a907a...bce5965b - 2 commits from branch eclipse/aidge:dev
• 9167db9e - aidge#199 (closed): update user guide of Node
• dc902933 - last minute corrections

Compare with previous version

added 1 commit

• 42f8d3a1 - aidge#199 (closed): update user guide of Node

Compare with previous version

added 17 commits

• 42f8d3a1...bf7c63df - 16 commits from branch eclipse/aidge:dev
• 8818b50d - aidge#199 (closed): update user guide of Node

Compare with previous version

added 3 commits

• 8818b50d...c2477042 - 2 commits from branch eclipse/aidge:dev
• 5a48d871 - aidge#199 (closed): update user guide of Node

Compare with previous version

added 24 commits

• 5a48d871...51618b23 - 23 commits from branch eclipse/aidge:dev
• b970661a - aidge#199 (closed): update user guide of Node

Compare with previous version

mentioned in issue aidge#199 (closed)

Is this ready for a review or a draft ? If the latest, please tag this as a draft

resolved all threads

changed title from Issue#199: Add documentation for Node to aidge#199: Add documentation for Node

added 28 commits

• b970661a...5991c8d6 - 27 commits from branch eclipse/aidge:dev
• 84e595ba - aidge#199 (closed): update user guide of Node

Compare with previous version

added 6 commits

• 84e595ba...0eaea479 - 5 commits from branch eclipse/aidge:dev
• cde5929c - aidge#199 (closed): update user guide of Node

Compare with previous version

added 4 commits

• cde5929c...b5623fb6 - 3 commits from branch eclipse/aidge:dev
• eba606bc - aidge#199 (closed): update user guide of Node

Compare with previous version

requested changes

Lots of typo and ill formed sentence I didn't review python code.

requested changes

added 1 commit

• d38368e8 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 8ab19092 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• c7501fbc - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 33bec62f - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 0f71dad7 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 41277ad8 - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

• 702ede8b - Apply 1 suggestion(s) to 1 file(s)

Compare with previous version