Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation in Inference Network class #113

Closed
skekre98 opened this issue Nov 4, 2020 · 7 comments
Closed

Improve documentation in Inference Network class #113

skekre98 opened this issue Nov 4, 2020 · 7 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs

Comments

@skekre98
Copy link
Owner

skekre98 commented Nov 4, 2020

Description of feature/enhancement
Current documentation in ../inference/inference_network.py is lacking. Could use better documentation.

Description of implementation
See ../modules/scraper.py for examples of documentation. Should be in following format:

"""
Function description
----------
input : type
    description of input parameter
Returns
-------
output : type
    description of output parameter
"""

Why this is a good feature/enhancement
Better documentation would make it easier for first time contributors to jump right into code base.

Additional context
n/a

@skekre98 skekre98 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers up-for-grabs labels Nov 4, 2020
@Florent18570
Copy link
Contributor

Hello can you affiliate me this issue ?

moki1202 added a commit to moki1202/NBA-Search that referenced this issue Jan 30, 2021
I have tried to  Improve documentation in Inference Network class skekre98#113
@smwitkowski
Copy link
Contributor

Just added some documentation for this file in #152.

Florent18570 added a commit to Florent18570/NBA-Search that referenced this issue Mar 28, 2021
Improve documentation in Inference Network class skekre98#113
@mohsinzafaruk1996
Copy link

Is this PR still being worked on, if not I would like to contribute :)

@nancyneelamma
Copy link

Update inference_network.py

@V3NN0W
Copy link

V3NN0W commented Aug 28, 2021

Hello there , this PR is it still open I would like to contribute ?

@skekre98
Copy link
Owner Author

Hi @V3NN0W, apologies this issue was meant to be closed a while ago.

@V3NN0W
Copy link

V3NN0W commented Aug 30, 2021 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed up-for-grabs
Projects
None yet
Development

No branches or pull requests

6 participants