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 - rework getting-started notebook. #1540

Merged
merged 25 commits into from
Sep 30, 2024

Conversation

ism200
Copy link
Collaborator

@ism200 ism200 commented Sep 27, 2024

Some minor updates to the readme to better reflect where we currently stand.

@jsnel reworked the getting-started notebook, and improved the installation instructions in the docs

@ism200 ism200 requested a review from a team as a code owner September 27, 2024 06:11
Copy link
Contributor

sourcery-ai bot commented Sep 27, 2024

🧙 Sourcery has finished reviewing your pull request!


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

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.

We've reviewed this pull request using the Sourcery rules engine. If you would also like our AI-powered code review then let us know.

@ism200
Copy link
Collaborator Author

ism200 commented Sep 27, 2024

beste joris, kan ik hier nu nog meer in editen, of moet het stap voor stap?

Copy link

codecov bot commented Sep 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.8%. Comparing base (2c88dce) to head (7b79787).
Report is 29 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##            main   #1540     +/-   ##
=======================================
+ Coverage   88.6%   88.8%   +0.1%     
=======================================
  Files        107     109      +2     
  Lines       5128    5245    +117     
  Branches     962     983     +21     
=======================================
+ Hits        4544    4658    +114     
  Misses       468     468             
- Partials     116     119      +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@s-weigand s-weigand left a comment

Choose a reason for hiding this comment

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

We should consistently use framework instead of library to prevent confusion.

README.md Outdated Show resolved Hide resolved
@jsnel jsnel requested review from a team as code owners September 28, 2024 19:06
@jsnel jsnel requested a review from s-weigand September 28, 2024 20:07
@jsnel jsnel dismissed s-weigand’s stale review September 28, 2024 20:08

The requested changes were made (by me)

s-weigand and others added 9 commits September 28, 2024 23:28
If they installed it already they don't need the guide :P
Slight rewording of installations instructions
Added initial commit to changelog
And quickstart_project to my_project
Added plot config
@jsnel jsnel changed the title Update README.md Improve documentation - rework getting-started guide and installation instructions. Sep 29, 2024
@jsnel jsnel changed the title Improve documentation - rework getting-started guide and installation instructions. 📚Improve documentation - rework getting-started notebook. Sep 29, 2024
jsnel
jsnel previously approved these changes Sep 29, 2024
Copy link
Member

@jsnel jsnel left a comment

Choose a reason for hiding this comment

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

Thanks for motivating us to improve the readme and the docs!

s-weigand
s-weigand previously approved these changes Sep 29, 2024
Copy link
Member

@s-weigand s-weigand left a comment

Choose a reason for hiding this comment

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

Very nice improvements to the docs that were long overdue 🚀

@jsnel jsnel dismissed stale reviews from s-weigand and themself via 7b79787 September 29, 2024 23:54
Copy link

@jsnel jsnel linked an issue Sep 30, 2024 that may be closed by this pull request
@jsnel jsnel merged commit eb8a1ea into glotaran:main Sep 30, 2024
38 checks passed
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.

📚 Rewrite quickstart to use pyglotaran_extras
3 participants