Skip to content

Commit

Permalink
example docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hrshdhgd committed Feb 10, 2024
1 parent 552ba6f commit c988a2b
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,28 @@ Inspect a package and display a file-language map.
code inspect <path>
```

##### example
```shell
code inspect code inspect src/codergpt/
Inspecting the code.
File Language
------------------------------------------ ----------
src/codergpt/constants.py Python
src/codergpt/__init__.py Python
src/codergpt/cli.py Python
src/codergpt/extensions.yaml YAML
src/codergpt/main.py Python
src/codergpt/optimizer/__init__.py Python
src/codergpt/utils/expression_evaluator.py Python
src/codergpt/utils/__init__.py Python
src/codergpt/commenter/commenter.py Python
src/codergpt/commenter/__init__.py Python
src/codergpt/explainer/explainer.py Python
src/codergpt/explainer/__init__.py Python
src/codergpt/test_writer/__init__.py Python
```


#### explain

Explain a specific function or class within a package.
Expand Down

0 comments on commit c988a2b

Please sign in to comment.