From c988a2b3ecfd9ff66096b9ec2fa44e909d968a6d Mon Sep 17 00:00:00 2001 From: Harshad Hegde Date: Fri, 9 Feb 2024 18:12:00 -0600 Subject: [PATCH] example docs --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index f2b7074..c599b08 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,28 @@ Inspect a package and display a file-language map. code inspect ``` +##### 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.