EnvisEdge icon indicating copy to clipboard operation
EnvisEdge copied to clipboard

📚 Documentation: write inline documentation for femnist_processor.py

Open ramesht007 opened this issue 2 years ago • 4 comments

🙋 Where

here :

  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L25
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L31
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L41
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L47
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L65
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L80
  • https://github.com/NimbleEdge/EnvisEdge/blob/00f554973085c54da98caf37721bec27ba07380d/datasets/femnist/femnist_processor.py#L91

💭 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 06:05 ramesht007

Hey, @ramesht007 I would like to work on this issue. Though this seems a bit new to me yet I am reviewing other prs similar to this. Looking forward to your help.Thanks in advance :)

haripriya9647 avatar May 01 '22 06:05 haripriya9647

hey @haripriya9647, please go ahead and take up the issue. When you put up a PR, I will assign the issue to you. thanks

ramesht007 avatar May 01 '22 12:05 ramesht007

@ramesht007 @haripriya9647 is this issue still open?

yashgosa avatar Sep 25 '22 03:09 yashgosa

@sofezticated-gentleman you can start working on this

haripriya9647 avatar Sep 25 '22 12:09 haripriya9647