Skip to content

Commit 16a4db4

Browse files
ptgoldenPatrick Golden
and
Patrick Golden
authored
Update documentation (#893)
### Summary * Renames docs page to "Monarch KG Tools" * Moves `release-process.md` from https://github.com/monarch-initiative/monarch-documentation/blob/main/src/docs/release-process.md into these docs * Updates CLI documentation after changes made in 64b4d01 * Folds the existing "Welcome", "Usage", and "Response Data Model" sections into one broader section for "monarch-py" * Removes the "API Reference" section, as it is redundant with information already contained in "Usage" ### Related issues - Closes #820 - [ ] All tests have passed (or issues created for failing tests) --------- Co-authored-by: Patrick Golden <[email protected]>
1 parent 1a1350d commit 16a4db4

File tree

6 files changed

+335
-293
lines changed

6 files changed

+335
-293
lines changed

backend/src/monarch_py/solr_cli.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,7 @@ def multi_entity_associations(
213213
typer.Option(
214214
"--counterpart-category",
215215
"-c",
216+
help="A comma-separated list of counterpart categories"
216217
),
217218
] = None,
218219
limit: fields.LimitOption = 20,
@@ -305,24 +306,23 @@ def histopheno(
305306

306307
@solr_app.command("association-counts")
307308
def association_counts(
308-
entity: Annotated[str, typer.Argument(help="The entity to get association counts for")],
309+
entity_id: Annotated[
310+
str, typer.Argument(help="The entity to get association counts for")
311+
],
309312
fmt: fields.FormatOption = fields.OutputFormat.json,
310313
output: fields.OutputOption = None,
311314
):
312315
"""
313316
Retrieve the association counts for a given entity
314317
"""
315-
if not entity:
316-
console.print("\n[bold red]Entity ID required.[/]\n")
317-
raise typer.Exit(1)
318318
solr = get_solr(update=False)
319-
response = solr.get_association_counts(entity)
319+
response = solr.get_association_counts(entity_id)
320320
format_output(fmt, response, output)
321321

322322

323323
@solr_app.command("association-table")
324324
def association_table(
325-
entity: Annotated[
325+
entity_id: Annotated[
326326
str,
327327
typer.Argument(
328328
help="The entity to get associations for",
@@ -357,7 +357,7 @@ def association_table(
357357
):
358358
solr = get_solr(update=False)
359359
response = solr.get_association_table(
360-
entity=entity,
360+
entity=entity_id,
361361
category=category,
362362
traverse_orthologs=traverse_orthologs,
363363
sort=sort,

backend/src/monarch_py/utils/cli_fields.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ class OutputFormat(str, Enum):
5151
Optional[str],
5252
typer.Option(
5353
"--output",
54-
"-o",
55-
help="The path to write command output (stdout if not specified)",
54+
"-O",
55+
help="Path to file to write command output (stdout if not specified)",
5656
),
5757
]

docs/API-Reference/index.md

-17
This file was deleted.

0 commit comments

Comments
 (0)