EnvisEdge
EnvisEdge copied to clipboard
📚 Documentation: Write inline documentation for envis_trainer.py
🙋 Where
Here:
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L16
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L43
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L81
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L85
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L92
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L103
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L112
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L150
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L219
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L225
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L245
- https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_trainer.py#L327
💭 Description
We need to go "line-by-line" and create inline documentation for this file. Please try to use proper punctuation and English grammar to the best of your ability.
We are using the pep8 format for documentation. The following links are concise and would be very useful:
pep8 guidelines numpy style guide
👀 Have you spent some time to check if this issue has been raised before?
- [X] I checked and didn't find similar issue
🏢 Have you read the guidlines?
- [X] I have read the Guildlines
🏢 Have you read the Code of Conduct?
- [X] I read the Code of Conduct
Hi, @ramesht007 can you guide me on how to fix this? I think inline documentation of python code would be fun to try something new.
Hi @ramesht007 I would like to work on this. Can you please assign me this task?
hey @ramesht007 is this issue still open ?