Skip to content

Commit 9f17c8b

Browse files
committed
Update README example output to use 'usage' terminology
- Change 'REFERENCE ANALYSIS' header to 'USAGE ANALYSIS' - Update '4 references' to '4 usages' in example output - Update JSON field names in examples: - total_references -> total_usages - referencing_files -> using_files - reference_path -> usage_path - Update command examples to use 'usages' instead of 'references' - Update jq example to query '.total_usages' instead of '.total_references'
1 parent 90d6775 commit 9f17c8b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

audit-cli/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -396,16 +396,16 @@ With `--include-toctree`, also tracks:
396396
**Text** (default):
397397
```
398398
============================================================
399-
REFERENCE ANALYSIS
399+
USAGE ANALYSIS
400400
============================================================
401401
Target File: /path/to/includes/intro.rst
402402
Total Files: 3
403403
Total Usages: 4
404404
============================================================
405405
406-
include : 3 files, 4 references
406+
include : 3 files, 4 usages
407407
408-
1. [include] duplicate-include-test.rst (2 references)
408+
1. [include] duplicate-include-test.rst (2 usages)
409409
2. [include] include-test.rst
410410
3. [include] page.rst
411411
@@ -414,16 +414,16 @@ include : 3 files, 4 references
414414
**Text with --verbose:**
415415
```
416416
============================================================
417-
REFERENCE ANALYSIS
417+
USAGE ANALYSIS
418418
============================================================
419419
Target File: /path/to/includes/intro.rst
420420
Total Files: 3
421421
Total Usages: 4
422422
============================================================
423423
424-
include : 3 files, 4 references
424+
include : 3 files, 4 usages
425425
426-
1. [include] duplicate-include-test.rst (2 references)
426+
1. [include] duplicate-include-test.rst (2 usages)
427427
Line 6: /includes/intro.rst
428428
Line 13: /includes/intro.rst
429429
2. [include] include-test.rst
@@ -439,24 +439,24 @@ include : 3 files, 4 references
439439
"target_file": "/path/to/includes/intro.rst",
440440
"source_dir": "/path/to/source",
441441
"total_files": 3,
442-
"total_references": 4,
443-
"referencing_files": [
442+
"total_usages": 4,
443+
"using_files": [
444444
{
445445
"file_path": "/path/to/duplicate-include-test.rst",
446446
"directive_type": "include",
447-
"reference_path": "/includes/intro.rst",
447+
"usage_path": "/includes/intro.rst",
448448
"line_number": 6
449449
},
450450
{
451451
"file_path": "/path/to/duplicate-include-test.rst",
452452
"directive_type": "include",
453-
"reference_path": "/includes/intro.rst",
453+
"usage_path": "/includes/intro.rst",
454454
"line_number": 13
455455
},
456456
{
457457
"file_path": "/path/to/include-test.rst",
458458
"directive_type": "include",
459-
"reference_path": "/includes/intro.rst",
459+
"usage_path": "/includes/intro.rst",
460460
"line_number": 6
461461
}
462462
]
@@ -473,7 +473,7 @@ include : 3 files, 4 references
473473
./audit-cli analyze usage ~/docs/source/code-examples/connect.py
474474

475475
# Get machine-readable output for scripting
476-
./audit-cli analyze usage ~/docs/source/includes/fact.rst --format json | jq '.total_references'
476+
./audit-cli analyze usage ~/docs/source/includes/fact.rst --format json | jq '.total_usages'
477477

478478
# See exactly where a file is referenced (with line numbers)
479479
./audit-cli analyze usage ~/docs/source/includes/intro.rst --verbose
@@ -501,10 +501,10 @@ include : 3 files, 4 references
501501
# Filter to only show include directives (not literalinclude or io-code-block)
502502
./audit-cli analyze usage ~/docs/source/includes/fact.rst --directive-type include
503503

504-
# Filter to only show literalinclude references
504+
# Filter to only show literalinclude usages
505505
./audit-cli analyze usage ~/docs/source/code-examples/example.py --directive-type literalinclude
506506

507-
# Combine filters: count only literalinclude references
507+
# Combine filters: count only literalinclude usages
508508
./audit-cli analyze usage ~/docs/source/code-examples/example.py -t literalinclude -c
509509

510510
# Combine filters: list files that use this as an io-code-block

0 commit comments

Comments
 (0)