EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

📚 Documentation: Write inline documentation for saver_utils.py

Open ramesht007 opened this issue 2 years ago • 3 comments

🙋 Where

Here

  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L12
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L21
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L30
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L47
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L58
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L105
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L124
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/fedrec/utilities/saver_utils.py#L135

💭 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

Hey @ramesht007, i would like to take this issue kindly assign me

imanishbarnwal avatar May 01 '22 06:05 imanishbarnwal

Hey @imanishbarnwal , go ahead 🚀

ramesht007 avatar May 01 '22 12:05 ramesht007

Hey @ramesht007 I sent PR #208 but it says merging is blocked I followed the style and formatting guide but still, it's happening can you please help me with this. Thank You!!

imanishbarnwal avatar May 03 '22 08:05 imanishbarnwal