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

Fix a configuration example in gantt.md #6001

Merged
merged 3 commits into from
Nov 28, 2024

Conversation

michaelbaudino
Copy link
Contributor

📑 Summary

According to the config schema docs, Gantt's tickInterval configuration must match the following regular expression, which does not allow any space:

/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/

This PR simply changes the example to be valid regarding this regular expression (otherwise, using the value in the example has no effect 😕).

📏 Design Decisions

N/A

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added necessary unit/e2e tests.
  • 📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
  • 🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

Copy link

changeset-bot bot commented Oct 28, 2024

⚠️ No Changeset found

Latest commit: 54d485f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for mermaid-js ready!

Name Link
🔨 Latest commit 54d485f
🔍 Latest deploy log https://app.netlify.com/sites/mermaid-js/deploys/674746dee9875600080301ca
😎 Deploy Preview https://deploy-preview-6001--mermaid-js.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

pkg-pr-new bot commented Oct 28, 2024

Open in Stackblitz

npm i https://pkg.pr.new/mermaid-js/mermaid@6001
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@6001
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@6001
npm i https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@6001

commit: 54d485f

Copy link

codecov bot commented Oct 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 4.48%. Comparing base (bff3282) to head (54d485f).
Report is 11 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6001   +/-   ##
=======================================
  Coverage     4.48%   4.48%           
=======================================
  Files          383     382    -1     
  Lines        54048   54037   -11     
  Branches       596     621   +25     
=======================================
  Hits          2425    2425           
+ Misses       51623   51612   -11     
Flag Coverage Δ
unit 4.48% <ø> (+<0.01%) ⬆️

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

see 1 file with indirect coverage changes

michaelbaudino and others added 2 commits October 29, 2024 13:09
According to the [config schema docs](https://mermaid.js.org/config/schema-docs/config-defs-gantt-diagram-config.html#tickinterval-constraints), Gantt's `tickInterval` configuration must match the following regular expression, which does **not** allow any space:

```regexp
/^([1-9][0-9]*)(millisecond|second|minute|hour|day|week|month)$/
```
@sidharthv96 sidharthv96 merged commit df636c6 into mermaid-js:develop Nov 28, 2024
16 of 21 checks passed
Copy link

mermaid-bot bot commented Nov 28, 2024

@michaelbaudino, Thank you for the contribution!
You are now eligible for a year of Premium account on MermaidChart.
Sign up with your GitHub account to activate.

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