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

Split the getting started docs #351

Merged
merged 3 commits into from
Jun 24, 2024

Conversation

tovrstra
Copy link
Member

This fixes one of the tasks in #191 and is also useful for #254 and #210.

The getting started guide is split in smaller bite-size parts. This also creates some more room for extending the getting started with a few more examples as mentioned in some of the cited issues.

The contents of the guide has not really changed, except maybe for the text in gettingstarted/index.rst

I will YOLO-merge this on Friday, June 28, unless reviewed earlier.

Copy link
Contributor

sourcery-ai bot commented Jun 23, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

deepsource-io bot commented Jun 23, 2024

Here's the code health analysis summary for commits b5bccd9..ce38390. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Shell LogoShell✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @tovrstra - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

docs/getting_started/units.rst Outdated Show resolved Hide resolved
Copy link
Member

@PaulWAyers PaulWAyers left a comment

Choose a reason for hiding this comment

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

Thanks Toon. I especially appreciate the way the units is explained clearly, with the rationale of using old-timey notation.

@tovrstra
Copy link
Member Author

Thanks for checking. Merging...

@tovrstra tovrstra merged commit b98bb35 into theochem:main Jun 24, 2024
12 checks passed
@tovrstra tovrstra deleted the split-getting-started branch June 24, 2024 05:43
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.

2 participants