EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

Published 20 hours ago • verified publisher icon NimbleEdge

📚 Documentation: Write inline documentation for envis_preprocessor.py

Open ramesht007 opened this issue 2 years ago • 3 comments

🙋 Where

here:

  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L8
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L21
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L24
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L27
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L30
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L37
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L41
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L46
  • https://github.com/NimbleEdge/EnvisEdge/blob/27a8c8762d2fe7e880ff6a379152084220294f27/fedrec/user_modules/envis_preprocessor.py#L55

💭 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 im not wrong inline documentation means python comments right? Sorry if the questions sounds silly😅

pratik2315 avatar May 05 '22 12:05 pratik2315

it is called inline documentation, as it is written with proper guidelines and formatting.

ramesht007 avatar May 06 '22 06:05 ramesht007

Hi @ramesht007 , I want to work on this issue . Can you please assign me this?

neelimagoogly avatar May 06 '22 12:05 neelimagoogly