Skip to content

Commit ee95be5

Browse files
committed
update docusaurus
1 parent 2d5c980 commit ee95be5

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

website/src/pages/index.mdx

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1074,8 +1074,8 @@ Favor expressive code over comments by using meaningful names and clear logic. C
10741074
10751075
Use comments when:
10761076
1077-
- Context or reasoning isn't obvious from the code (e.g., config files, workarounds).
1078-
- You need to reference related issues, PRs, or future improvements.
1077+
- The context or reasoning isn't obvious from the code alone (e.g. config files, workarounds)
1078+
- Referencing related issues, PRs, or planned improvements
10791079
10801080
```ts
10811081
// ❌ Avoid
@@ -1090,7 +1090,7 @@ const minutes = seconds * SECONDS_IN_MINUTE;
10901090
const averageUsersPerMinute = noOfUsers / minutes;
10911091

10921092
// ✅ Use - Add context to explain why
1093-
// TODO: Filtering should be moved to the backend once API changes are released.
1093+
// TODO: Move filtering to the backend once API v2 is released.
10941094
// Issue/PR - https://github.com/foo/repo/pulls/55124
10951095
const filteredUsers = frontendFiltering(selectedUsers);
10961096
// Use Fourier transformation to minimize information loss - https://github.com/dntj/jsfft#usage
@@ -1108,27 +1108,21 @@ Use TSDoc comments when documenting APIs, libraries, configuration or reusable c
11081108
* Configuration options for the Web3 SDK.
11091109
*/
11101110
export type Web3Config = {
1111-
/**
1112-
* Ethereum network chain ID.
1113-
*/
1111+
/** Ethereum network chain ID. */
11141112
chainId: number;
11151113

11161114
/**
1117-
* Gas price strategy for transactions.
1118-
* - `fast`: Higher fees, faster confirmation.
1119-
* - `standard`: Balanced.
1120-
* - `slow`: Lower fees, slower confirmation.
1115+
* Gas price strategy for transactions:
1116+
* - `fast`: Higher fees, faster confirmation
1117+
* - `standard`: Balanced
1118+
* - `slow`: Lower fees, slower confirmation
11211119
*/
11221120
gasPriceStrategy: 'fast' | 'standard' | 'slow';
11231121

1124-
/**
1125-
* Maximum gas limit per transaction.
1126-
*/
1122+
/** Maximum gas limit per transaction. */
11271123
maxGasLimit?: number;
11281124

1129-
/**
1130-
* Enables event listening for smart contract interactions.
1131-
*/
1125+
/** Enables event listening for smart contract interactions. */
11321126
enableEventListener?: boolean;
11331127
};
11341128
```

0 commit comments

Comments
 (0)