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

Docs improvements #18

Merged
merged 3 commits into from
May 16, 2021
Merged

Docs improvements #18

merged 3 commits into from
May 16, 2021

Conversation

ben-hampson
Copy link
Contributor

@ben-hampson ben-hampson commented May 16, 2021

README.md: Fixes #16

  • Fixed the virtualenv setup command
  • Fixes the source command in 2 places

SleeveDecreases.md:

  • Fixed the import statement (it didn't import the class before)
  • Updated it to use the correct class name: SwatchGaugeSwatch

Note: I'm new to contributing and trying to figure this out! I didn't realise multiple PRs from my main branch merged into one PR with multiple commits on different issues. Not ideal but not sure how to do it differently? Also, I only opened an issue for one problem: the README stuff. Should I have opened a separate issue for the SleeveDecreases.md fix too first? I welcome feedback.

- Fix the import statement
- Update the class name from `Swatch` to `GaugeSwatch`
Copy link
Owner

@terriko terriko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! And yes, I did change the name of the swatch class at some point, hence the discrepancy!

@terriko terriko merged commit cba32f3 into terriko:main May 16, 2021
@terriko terriko mentioned this pull request May 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Jupyter-lab setup instructions
2 participants