Skip to content

Update vocabulary.md#68

Open
darksapien23151 wants to merge 2 commits into
accordproject:mainfrom
darksapien23151:main
Open

Update vocabulary.md#68
darksapien23151 wants to merge 2 commits into
accordproject:mainfrom
darksapien23151:main

Conversation

@darksapien23151
Copy link
Copy Markdown

Documentation for support multiple vocabulary terms for a element.

Closes #

Changes

  • Documentation change demonstratin the new added feature: supporting multiple terms per concept/ property.
  • Changed the YAML files.

Related Issues

doc change for multiple vocab description
@netlify
Copy link
Copy Markdown

netlify Bot commented Jan 13, 2025

Deploy Preview for concerto-docs ready!

Name Link
🔨 Latest commit 3fc1810
🔍 Latest deploy log https://app.netlify.com/sites/concerto-docs/deploys/6784912da258e90008804274
😎 Deploy Preview https://deploy-preview-68--concerto-docs.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.

@darksapien23151 darksapien23151 marked this pull request as draft January 13, 2025 03:50
@darksapien23151 darksapien23151 marked this pull request as ready for review January 13, 2025 03:56
@darksapien23151 darksapien23151 marked this pull request as draft January 13, 2025 03:57
@darksapien23151 darksapien23151 marked this pull request as ready for review January 13, 2025 04:11
Comment thread docs/design/vocabulary.md
---

The Vocabulary module for Concerto optionally allows human-readable labels (Terms) to be associated with model elements. Terms are stored within a locale specific vocabulary YAML file associated with a Concerto namespace.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Why this extra line?

Comment thread docs/design/vocabulary.md
- Truck: A vehicle capable of carrying cargo
properties:
- weight: The weight of the truck in KG
- Color:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Comment thread docs/design/vocabulary.md
```
const term = vocabularyManager.getTerm('org.acme', 'en-gb', 'Color');
// term.should.equal('A colour');
const shortTerm = vocabularyManager.getTerm('org.acme', 'en-gb', 'Color', { termType: 'short' });
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
const shortTerm = vocabularyManager.getTerm('org.acme', 'en-gb', 'Color', { termType: 'short' });
const shortTerm = vocabularyManager.getTerm('org.acme', 'en-gb', 'Color', 'short');

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

API signature is different from the one mentioned here in this change. You may want to update at other places as well.

@sanketshevkar
Copy link
Copy Markdown
Member

@darksapien23151 if you've used any AI tools for this task, can you please add an AI-Assistant tag to the PR. We are completely fine with using AI tools to help you with the dev work. But as we reviewers we have to be extra vigilant during our reviews to avoid slip ups.

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