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.

Sign up for GitHub

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

Jump to bottom

Improved documentation, contribution instructions and .gitignore #57

Merged
merged 9 commits into from
Sep 30, 2022
Merged

Improved documentation, contribution instructions and .gitignore #57

merged 9 commits into from
Sep 30, 2022

Conversation

kdgutier
Copy link
Collaborator

@kdgutier kdgutier commented Sep 28, 2022 •
edited
Loading

  • Added new .gitignore protections
  • General docstrings for core, methods, evaluation, and utils.
  • Changed HierarchicalReconciliation input from Y_h-> Y_hat_df.
  • Changed order within sidebar.yml
  • Improved general references of the methods.
  • Added numeration to methods documentation.
  • Improved core and methods introductions.
  • Improved CONTRIBUTING.md instructions.
  • Added documentation link to the README page.
  • Changed problematic Microsoft character “ -> ". Fixed 'charmap' codec can't decode byte 0x9d problem.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@kdgutier kdgutier requested a review from AzulGarza September 28, 2022 21:46
@kdgutier kdgutier merged commit 149890a into main Sep 30, 2022
@kdgutier kdgutier deleted the ImprovedDocumentation branch September 30, 2022 13:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AzulGarza AzulGarza Awaiting requested review from AzulGarza

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@kdgutier