Skip to content

fix(docs): error in tooltips directive example #4791

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 1 commit into from
Feb 18, 2020

Conversation

sebastian-raubach
Copy link
Contributor

Fixed a mistake in the js code example.

Describe the PR

The tooltip directive documentation had a mistake in the example where it showed how to hide a tooltip.

this.$root.$emit('bv::show::tooltip', 'my-trigger-button-id')

should have been

this.$root.$emit('bv::hide::tooltip', 'my-trigger-button-id')

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, chore(docs): 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)
  • Includes any needed TypeScript declaration file updates
  • New/updated tests are included and passing (if required)
  • Existing test suites are passing
  • CodeCov for patch has met target
  • 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)

Fixed a mistake in the js code example.
@codecov
Copy link

codecov bot commented Feb 18, 2020

Codecov Report

Merging #4791 into dev will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4791   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files         263      263           
  Lines        5847     5847           
  Branches     1526     1526           
=======================================
  Hits         5843     5843           
  Misses          3        3           
  Partials        1        1

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 8625e99...dee0211. Read the comment docs.

@jacobmllr95 jacobmllr95 changed the title fix(docs): Error in tooltips directive example fix(docs): error in tooltips directive example Feb 18, 2020
@jacobmllr95 jacobmllr95 self-requested a review February 18, 2020 15:09
@jacobmllr95 jacobmllr95 merged commit 39829be into bootstrap-vue:dev Feb 18, 2020
@jacobmllr95
Copy link
Member

Thanks @sebastian-raubach!

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.

2 participants