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

Update docs for deprecated usage of Package::boot() #39

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Conversation

tfrommen
Copy link
Member

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • Docs have been added/updated (for bug fixes/features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)

Update docs so they no longer include deprecated functionality.

What is the current behavior? (You can also link to an open issue here)

Currently, two pieces of documentation include the deprecated usage of Package::boot() with one or more module instances being passed to the method.

What is the new behavior (if this is a feature change)?

The documentation shows adding modules and booting the package in separate calls to addModule() and boot(), respectively.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)

No.

Other information:

@tfrommen tfrommen requested review from gmazzap and Chrico November 27, 2023 19:41
Copy link

codecov bot commented Nov 27, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8564405) 98.86% compared to head (f12590f) 98.86%.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #39   +/-   ##
=========================================
  Coverage     98.86%   98.86%           
  Complexity      189      189           
=========================================
  Files             9        9           
  Lines           528      528           
=========================================
  Hits            522      522           
  Misses            6        6           
Flag Coverage Δ
unittests 98.86% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Copy link
Member

@Chrico Chrico left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks 💪🏻

@Chrico Chrico merged commit 7ace0e8 into master Nov 28, 2023
67 of 68 checks passed
@Chrico Chrico deleted the update-docs branch November 28, 2023 06:58
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