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

[Internal] [Bug] Update README and Params #42

Closed
ankushkgupta2 opened this issue May 3, 2023 · 0 comments
Closed

[Internal] [Bug] Update README and Params #42

ankushkgupta2 opened this issue May 3, 2023 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@ankushkgupta2
Copy link
Contributor

ankushkgupta2 commented May 3, 2023

What is the Bug Related To? Please Provide a Description. 
README.md needs to be updated for the latest enhancements. Also, potentially add more verbose comments and docstrings throughout the parameter sets for the user.

Categorize the Severity of the Bug from 1-5: 3

  • 1 = most severe (a full-break in core function)
  • 2-4 = moderate (break for a particular aspect/feature) (how integral is the broken feature?)
  • 5 = least severe (non-functional issue, such as inconsistency / error in documentation or administrative in nature) 

Please Complete the Following Information:

  • OS: [e.g. iOS]:
  • Browser [e.g. chrome, safari]:
  • Version [e.g. 22]:
  • Run environment (container, cloud service, HPC, platform, etc.):

Please Outline Necessary Steps to Replicate Bug (Go to.. Click on... Install the following... etc.):
N/A

Any Additional Context or Information? Has There Been Any Progress Made So Far Towards this Request? Any Concrete Instructions to Resolve the Bug or Helpful Resources to Reference? Screenshots or Logs?
N/A

@ankushkgupta2 ankushkgupta2 added bug Something isn't working documentation Improvements or additions to documentation labels May 3, 2023
@ankushkgupta2 ankushkgupta2 added this to the v1.0.0 milestone May 3, 2023
@ankushkgupta2 ankushkgupta2 self-assigned this May 3, 2023
@ankushkgupta2 ankushkgupta2 changed the title [Internal] [Bug] Remove Unecessary Params + Change Names [Internal] [Bug] Improve Parameter Documentation Jun 22, 2023
@ankushkgupta2 ankushkgupta2 changed the title [Internal] [Bug] Improve Parameter Documentation [Internal] [Bug] Update README and Params Dec 13, 2023
kyleoconnell added a commit that referenced this issue Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants