Skip to content

Commit 8b26bbb

Browse files
committed
docs: mozilla#377 update mdbook readme
- changed commands readme in mdbook - included information related of current structure
1 parent f43652b commit 8b26bbb

File tree

1 file changed

+4
-12
lines changed
  • rust-code-analysis-book/src/commands

1 file changed

+4
-12
lines changed

rust-code-analysis-book/src/commands/README.md

+4-12
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,15 @@
11
# Commands
22

3-
With the term **command**, we define any procedure used by
4-
**rust-code-analysis-cli** to extract information from source codes.
5-
At each command **may** be associated parameters depending on the task
6-
it needs to carry out.
7-
In this page we have grouped the principal **types** of commands implemented in
8-
**rust-code-analysis-cli**.
3+
The **rust-code-analysis-cli** offers a range of **commands** to analyze source code and extract valuable insights. Each command **may** include parameters specific to the task it performs. Below, we describe the core types of commands available in **rust-code-analysis-cli**.
94

105
## Metrics
116

12-
Metrics are a series of measures that can be used to:
7+
Metrics provide quantitative measures about source code, which can help in:
138

149
- Compare different programming languages
1510
- Provide information on the quality of a code
1611
- Tell developers where their code is more tough to handle
17-
- Discover errors earlier
12+
- Discovering potential issues early in the development process
1813

1914
**rust-code-analysis** calculates the metrics starting from the
2015
source code of a program. These kind of metrics are called *static metrics*.
@@ -37,7 +32,4 @@ Nodes can be used to:
3732

3833
## REST API
3934

40-
**rust-code-analysis-cli** can be run as a server which accepts requests sent
41-
through `REST API`.
42-
The server receives in input the filename of a source code file and returns the
43-
relative metrics formatted as a `json` file.
35+
The **rust-code-analysis-web** can function as a server using a REST API. This allows users to send source code via HTTP and receive corresponding metrics in `JSON` format, enabling easy integration into web applications or other services.

0 commit comments

Comments
 (0)