Skip to content

Commit 19c494d

Browse files
jman4162claude
andcommitted
Format docs-related files
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NoLtnms93KQL7Jsp9GrZZo
1 parent 447bf9e commit 19c494d

2 files changed

Lines changed: 9 additions & 6 deletions

File tree

docs/api-client.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ from sysml2kit.api import SysMLApiClient
1010
with SysMLApiClient("https://models.example.com", token="") as client:
1111
for project in client.list_projects():
1212
print(project.id, project.name)
13-
model = client.list_elements(project_id, commit_id) # -> sysml2kit Model
13+
model = client.list_elements(project_id, commit_id) # -> sysml2kit Model
1414
client.push_model(project_id, model, message="update")
1515
```
1616

docs/quickstart.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,21 @@ model = Model()
1313
pkg = builder.pkg(model, "Vehicle")
1414
battery = builder.part(model, "battery", owner=pkg)
1515
range_req = builder.req(
16-
model, "REQ-001", "Range", owner=pkg,
16+
model,
17+
"REQ-001",
18+
"Range",
19+
owner=pkg,
1720
text="The vehicle shall travel at least 400 km on one charge.",
1821
)
1922
builder.satisfy(model, source=battery, target=range_req)
2023

21-
print(unverified_requirements(model)) # [REQ-001] - nothing verifies it yet
22-
print(trace_matrix(model).render()) # requirement-by-part grid
24+
print(unverified_requirements(model)) # [REQ-001] - nothing verifies it yet
25+
print(trace_matrix(model).render()) # requirement-by-part grid
2326
for issue in validate(model):
2427
print(issue.rule_id, issue.severity, issue.message)
2528

26-
print(write_model(model)) # SysML v2 textual notation
27-
write_json(model, "vehicle.json") # Systems Modeling API interchange
29+
print(write_model(model)) # SysML v2 textual notation
30+
write_json(model, "vehicle.json") # Systems Modeling API interchange
2831
```
2932

3033
The same operations from the command line:

0 commit comments

Comments
 (0)