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

docs: improve code examples and enhance wording (closes #4859) #4882

Merged
merged 6 commits into from Mar 5, 2020

Conversation

@jackmu95
Copy link
Member

jackmu95 commented Mar 5, 2020

Describe the PR

This PR adds support to define filenames to code examples by adding a comment to the first.
The filename will be removed from the code example and will be displayed on the right top of the example (like the "Live" text for play examples).

// custom.scss
@import 'node_modules/bootstrap/scss/bootstrap';
@import 'node_modules/bootstrap-vue/src/index.scss';

Additionally the wording about the custom.scss was enhanced.

Closes #4859.

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)
@jackmu95 jackmu95 requested a review from tmorehouse Mar 5, 2020
@jackmu95 jackmu95 added this to In progress in 2.6.1 via automation Mar 5, 2020
@codecov

This comment has been minimized.

Copy link

codecov bot commented Mar 5, 2020

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #4882   +/-   ##
=======================================
  Coverage   99.93%   99.93%           
=======================================
  Files         269      269           
  Lines        6111     6111           
  Branches     1595     1595           
=======================================
  Hits         6107     6107           
  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 bda2a04...f08a93f. Read the comment docs.

@tmorehouse tmorehouse changed the title feat(docs): improve code examples and enhance wording (closes #4859) docs: improve code examples and enhance wording (closes #4859) Mar 5, 2020
@tmorehouse tmorehouse removed this from In progress in 2.6.1 Mar 5, 2020
@tmorehouse tmorehouse added the PR: Patch label Mar 5, 2020
@jackmu95 jackmu95 merged commit 6e6d17e into dev Mar 5, 2020
9 checks passed
9 checks passed
License Compliance All checks passed.
Details
ci/circleci: build Your tests passed on CircleCI!
Details
ci/circleci: lint Your tests passed on CircleCI!
Details
ci/circleci: setup Your tests passed on CircleCI!
Details
ci/circleci: test Your tests passed on CircleCI!
Details
codecov/patch Coverage not affected when comparing bda2a04...f08a93f
Details
codecov/project 99.93% remains the same compared to bda2a04
Details
netlify/bootstrap-vue/deploy-preview Deploy preview ready!
Details
security/snyk (pi0) No manifest changes detected
Details
@jackmu95 jackmu95 deleted the fix-docs-minor-improvements branch Mar 5, 2020
@jackmu95 jackmu95 added this to In progress in 2.6.1 via automation Mar 5, 2020
@tmorehouse tmorehouse moved this from In progress to Done in 2.6.1 Mar 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2.6.1
  
Done
Linked issues

Successfully merging this pull request may close these issues.

2 participants
You can’t perform that action at this time.