EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

πŸ“š Documentation: Write inline documentation for io_utils.py

Open ramesht007 opened this issue 2 years ago β€’ 2 comments

πŸ™‹ Where

Here:

  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L7
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L15
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L19
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L32
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L43
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L51
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L56
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/io_utils.py#L69

πŸ’­ 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 01 '22 05:05 ramesht007

HelloΒ @ramesht007Β , I can work on this issue. I went through the pep8 guidelines and also checked some merged inline docs to get proper idea

BhaswatiRoy avatar May 01 '22 07:05 BhaswatiRoy

Hey @BhaswatiRoy, great to know that you went through the guidelines. Go ahead and work on it.

ramesht007 avatar May 01 '22 12:05 ramesht007