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

Edit introduction vignette #57

Merged
merged 10 commits into from
Jan 28, 2025
Merged

Edit introduction vignette #57

merged 10 commits into from
Jan 28, 2025

Conversation

SofiaOtero
Copy link
Contributor

@SofiaOtero SofiaOtero commented Jan 20, 2025 •
edited
Loading

The PR edits the introduction vignette, such as there is a simple guide to use the package by clicking on Get started.
In this guide there will be references to vignettes that explain each function more in detail.

Additionally:

  • the seasonal_onset documentation has been moved to it's own vignette.
  • a new autoplot has been added and the code has been refactored.

This PR is a prerequisite to solve:

Checklist

  • The PR passes all local unit tests
  • I have documented any new features introduced
  • If the PR adds a new feature, please add an entry in NEWS.md
  • A reviewer is assigned to this PR

@SofiaOtero SofiaOtero added the documentation Improvements or additions to documentation label Jan 20, 2025
@SofiaOtero SofiaOtero self-assigned this Jan 20, 2025
@SofiaOtero SofiaOtero force-pushed the edit_introduction_vignette branch from a9a4979 to b4ee30f Compare January 21, 2025 14:38
@SofiaOtero SofiaOtero added the refactor improve code without changing functionality label Jan 23, 2025
@SofiaOtero SofiaOtero marked this pull request as ready for review January 24, 2025 10:09
RasmusSkytte
RasmusSkytte reviewed Jan 24, 2025
View reviewed changes
RasmusSkytte
RasmusSkytte approved these changes Jan 24, 2025
View reviewed changes
Copy link
Contributor

@RasmusSkytte RasmusSkytte left a comment

Choose a reason for hiding this comment

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

Overall good changes. Plots and vignettes look good.

Some suggestions for further improvements.

Also, consider the git history of this PR. There are a lot of "WIP" commits.

@SofiaOtero SofiaOtero merged commit 816332b into master Jan 28, 2025
13 checks passed
@SofiaOtero SofiaOtero deleted the edit_introduction_vignette branch January 28, 2025 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RasmusSkytte RasmusSkytte RasmusSkytte approved these changes

@LasseEngboChr LasseEngboChr Awaiting requested review from LasseEngboChr

Assignees

@SofiaOtero SofiaOtero

Labels
documentation Improvements or additions to documentation refactor improve code without changing functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SofiaOtero @RasmusSkytte