EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

📚 Documentation: Write inline documentation for envis_base_module.py

Open ramesht007 opened this issue 3 years ago • 2 comments

🙋 Where

Here:

  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L10
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L22
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L53
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L92
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L96
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_base_module.py#L113

💭 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

ramesht007 avatar May 05 '22 10:05 ramesht007

Hey @ramesht007 If its okay with you can i work on this issue?

pratik9315 avatar May 05 '22 12:05 pratik9315

yes, @pratik2315 go ahead 🚀

ramesht007 avatar May 06 '22 01:05 ramesht007