Skip to content

chore(docs): minor docs updates (closes #3262) #3263

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

Merged
merged 9 commits into from
May 10, 2019

Conversation

tmorehouse
Copy link
Member

@tmorehouse tmorehouse commented May 9, 2019

Describe the PR

Minor updates to some docs

Also adds a warn when accessing $bvModal and $bvToast not via the this context (i.e. attempting to use Vue.prototype.$bvToast(...)).

Closes #3262

PR checklist

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Enhancement
  • ARIA accessibility
  • Documentation update
  • Other (please describe)

Does this PR introduce a breaking change? (check one)

  • No
  • Yes (please describe)

The PR fulfills these requirements:

  • It's submitted to the dev branch, not the master branch
  • When resolving a specific issue, it's referenced in the PR's title (i.e. [...] (fixes #xxx[,#xxx]), where "xxx" is the issue number)
  • It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
  • The title should follow the Conventional Commits naming convention (i.e. fix(alert): not alerting during SSR render, docs(badge): update pill examples, fix typos, chore: fix typo in README, etc). This is very important, as the CHANGELOG is generated from these messages.

If new features/enhancement/fixes are added or changed:

  • Includes documentation updates (including updating the component's package.json for slot and event changes)
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • The changes have not impacted the functionality of other components or directives
  • ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)

If adding a new feature, or changing the functionality of an existing feature, the PR's
description above includes:

  • A convincing reason for adding this feature (to avoid wasting your time, it's best to open a suggestion issue first and wait for approval before working on it)

@codecov
Copy link

codecov bot commented May 9, 2019

Codecov Report

Merging #3263 into dev will increase coverage by <.01%.
The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff            @@
##             dev   #3263      +/-   ##
========================================
+ Coverage   99.2%   99.2%   +<.01%     
========================================
  Files        217     217              
  Lines       4154    4156       +2     
  Branches    1193    1193              
========================================
+ Hits        4121    4123       +2     
  Misses        26      26              
  Partials       7       7
Impacted Files Coverage Δ
src/utils/warn.js 100% <100%> (ø) ⬆️
src/components/modal/helpers/bv-modal.js 100% <100%> (ø) ⬆️
src/components/toast/helpers/bv-toast.js 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 10d4c4d...bc76190. Read the comment docs.

@tmorehouse tmorehouse changed the title chore(docs): minor docs updates chore(docs): minor docs updates (closes #3262) May 9, 2019
@tmorehouse tmorehouse marked this pull request as ready for review May 9, 2019 13:54
@tmorehouse tmorehouse requested a review from jacobmllr95 May 9, 2019 13:54
@bootstrap-vue bootstrap-vue deleted a comment from codecov bot May 9, 2019
@jacobmllr95 jacobmllr95 merged commit e2ef9f6 into dev May 10, 2019
@jacobmllr95 jacobmllr95 deleted the tmorehouse/docs-updates branch May 10, 2019 07:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

$bvToast not accessible from axios interceptor
2 participants