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

Add entry for samm exporter in the vspec docs - help example. #434

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/vspec.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@ For the most up do date usage information, please call the tool help via:
vspec export --help

Usage: vspec export [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────╮
│ apigear Export to ApiGear. │
│ binary Export to Binary. │
│ csv Export as CSV. │
│ ddsidl Export as DDSIDL. │
│ franca Export as Franca. │
│ graphql Export as GraphQL. │
│ id Export as IDs. │
│ json Export as JSON. │
│ jsonschema Export as a jsonschema. │
│ protobuf Export as protobuf. │
│ yaml Export as YAML. │
│ tree Export as Tree. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ apigear Export to ApiGear. │
│ binary Export to Binary. │
│ csv Export as CSV. │
│ ddsidl Export as DDSIDL. │
│ franca Export as Franca. │
│ graphql Export as GraphQL. │
│ id Export as IDs. │
│ json Export as JSON. │
│ jsonschema Export as a jsonschema. │
│ protobuf Export as protobuf. │
| samm Export as Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files. |
│ yaml Export as YAML. │
│ tree Export as Tree. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```


Expand Down
2 changes: 1 addition & 1 deletion src/vss_tools/exporters/samm/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ def cli(
split_depth,
) -> None:
"""
Export COVESA VSS to Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files.
Export as Eclipse Semantic Modeling Framework (ESMF) - Semantic Aspect Meta Model (SAMM) - .ttl files.
"""

log.info("Loading VSS Tree...\n")
Expand Down
Loading