Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor doc fixes #1655

Merged
merged 1 commit into from
Nov 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/source/connectors/ethereum-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,11 +305,11 @@ To query a state on a contract state, set the `readOnly` attribute to `true`. Th

## Transaction Data Gathered by the Adapter

The previously discussed `invokeSmartContract` and `queryState` functions return an array whose elements correspond to the result of the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger/caliper/blob/v0.6.0/packages/caliper-core/lib/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.
The previously discussed `sendRequests` method returns an array whose elements correspond to the result of the submitted request(s) with the type of [TxStatus](https://github.com/hyperledger/caliper/blob/v0.6.0/packages/caliper-core/lib/transaction-status.js). The class provides some standard and platform-specific information about its corresponding transaction.

The standard information provided by the type are the following:

- `GetID():string` returns the transaction ID for `invokeSmartContract`, `null` for `queryState` and `querySmartContract`.
- `GetID():string` returns the transaction ID.
- `GetStatus():string` returns the final status of the transaction, either `success` or `failed`.
- `GetTimeCreate():number` returns the epoch when the transaction was submitted.
- `GetTimeFinal():number` return the epoch when the transaction was finished.
Expand Down
8 changes: 4 additions & 4 deletions docs/source/getting-started/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ user@ubuntu:~/caliper$ ./.build/check-prerequisites.sh && npm ci

### Public/published packages

The [https://github.com/hyperledger/caliper/tree/main/packages/](packages) directory contains the following public/published packages:
The [packages](https://github.com/hyperledger/caliper/tree/main/packages/) directory contains the following public/published packages:

* [caliper-cli](https://github.com/hyperledger/caliper/tree/main/packages/caliper-cli/): The command line interface (CLI) of Caliper.
* [caliper-core](https://github.com/hyperledger/caliper/tree/main/packages/caliper-core/): The core and common codebase of Caliper, used by the other packages.
Expand All @@ -169,7 +169,7 @@ The [https://github.com/hyperledger/caliper/tree/main/packages/](packages) direc

### Internal packages

The [https://github.com/hyperledger/caliper/tree/main/packages/](packages) directory contains the following internal packages:
The [packages](https://github.com/hyperledger/caliper/tree/main/packages/) directory contains the following internal packages:

* [caliper-publish](https://github.com/hyperledger/caliper/tree/main/packages/caliper-publish/): Utility CLI for publishing Caliper to NPM and DockerHub.
* [caliper-tests-integration](https://github.com/hyperledger/caliper/tree/main/packages/caliper-tests-integration/): Collection of CI integration tests.
Expand All @@ -187,7 +187,7 @@ Unit testing focuses on testing individual packages in isolation. The tests are
The following are the recommended testing modules for this project. While these tools are commonly used in the current codebase, other appropriate tools may be used as long as they facilitate effective testing.

* [mockery](https://www.npmjs.com/package/mockery): Mockery is a simple module for mocking Node.js modules during testing. It allows you to replace real modules with mocks or stubs.

* [mocha](https://mochajs.org/): Mocha is a feature-rich JavaScript test framework that runs on Node.js and in the browser. It facilitates asynchronous testing, making it easy to write simple and flexible tests.

* [chai](https://www.npmjs.com/package/chai): Chai is a BDD/TDD assertion library for Node.js and the browser. It can be paired with any JavaScript testing framework. We use it to create readable and expressive assertions.
Expand Down Expand Up @@ -468,7 +468,7 @@ Please adhere to the inclusive language guidelines that the project has adopted
```sh
mkdocs build
```

This command generates static files in the site directory.

5. **Previewing Locally**:
Expand Down
Loading