Skip to content

docs: fix typo and formatting in README and code comments#1238

Merged
songgaoye merged 2 commits intocrypto-org-chain:masterfrom
tsinglua:master
Mar 17, 2026
Merged

docs: fix typo and formatting in README and code comments#1238
songgaoye merged 2 commits intocrypto-org-chain:masterfrom
tsinglua:master

Conversation

@tsinglua
Copy link
Copy Markdown
Contributor

@tsinglua tsinglua commented Mar 11, 2026

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

This commit fixes minor documentation issues:

  • Corrects "integrations tests" to "integration tests" in README.md
  • Removes extra spaces in code comment examples in x/nft-transfer/types/trace.go

These changes improve documentation clarity and maintain consistent formatting standards.

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

@tsinglua tsinglua requested a review from a team as a code owner March 11, 2026 08:50
@tsinglua tsinglua requested review from JayT106 and XinyuCRO and removed request for a team March 11, 2026 08:50
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 33.50%. Comparing base (d548d3d) to head (8d1dd7e).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1238   +/-   ##
=======================================
  Coverage   33.50%   33.50%           
=======================================
  Files         105      105           
  Lines       15728    15728           
=======================================
  Hits         5270     5270           
  Misses       9415     9415           
  Partials     1043     1043           
Flag Coverage Δ
integration_tests 26.02% <ø> (ø)
integration_tests_byzantine 11.52% <ø> (ø)
integration_tests_gov 11.76% <ø> (ø)
integration_tests_grpc 11.76% <ø> (ø)
integration_tests_ibc 26.76% <ø> (ø)
integration_tests_ledger 11.74% <ø> (ø)
integration_tests_slow 11.74% <ø> (ø)
integration_tests_solomachine 11.55% <ø> (ø)
integration_tests_upgrade 11.76% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@songgaoye songgaoye self-requested a review March 12, 2026 01:11
@songgaoye songgaoye enabled auto-merge March 12, 2026 01:11
@songgaoye
Copy link
Copy Markdown
Contributor

songgaoye commented Mar 12, 2026

@tsinglua please fix fmt. Thank you!

index 449caa4..140f4ee 100644
--- a/x/nft-transfer/types/trace.go
+++ b/x/nft-transfer/types/trace.go
@@ -56,8 +56,8 @@ func IsAwayFromOrigin(sourcePort, sourceChannel, fullClassPath string) bool {
 //
 // Examples:
 //
-//  - "port-1/channel-1/class-1" => ClassTrace{Path: "port-1/channel-1", BaseClassId: "class-1"}
-//  - "class-1" => ClassTrace{Path: "", BaseClassId: "class-1"}
+//   - "port-1/channel-1/class-1" => ClassTrace{Path: "port-1/channel-1", BaseClassId: "class-1"}
+//   - "class-1" => ClassTrace{Path: "", BaseClassId: "class-1"}
 func ParseClassTrace(rawClassID string) ClassTrace {

https://github.com/crypto-org-chain/chain-main/actions/runs/22944349905/job/66723146500?pr=1238 ci failed not related to this pr. will fix in pr #1239

Signed-off-by: tsinglua <tsinglua@outlook.com>
auto-merge was automatically disabled March 12, 2026 02:39

Head branch was pushed to by a user without write access

@tsinglua
Copy link
Copy Markdown
Contributor Author

@tsinglua please fix fmt. Thank you!

index 449caa4..140f4ee 100644
--- a/x/nft-transfer/types/trace.go
+++ b/x/nft-transfer/types/trace.go
@@ -56,8 +56,8 @@ func IsAwayFromOrigin(sourcePort, sourceChannel, fullClassPath string) bool {
 //
 // Examples:
 //
-//  - "port-1/channel-1/class-1" => ClassTrace{Path: "port-1/channel-1", BaseClassId: "class-1"}
-//  - "class-1" => ClassTrace{Path: "", BaseClassId: "class-1"}
+//   - "port-1/channel-1/class-1" => ClassTrace{Path: "port-1/channel-1", BaseClassId: "class-1"}
+//   - "class-1" => ClassTrace{Path: "", BaseClassId: "class-1"}
 func ParseClassTrace(rawClassID string) ClassTrace {
 `` `

@songgaoye Thanks. Modified.

Please review it again.

@songgaoye songgaoye added this pull request to the merge queue Mar 17, 2026
Merged via the queue into crypto-org-chain:master with commit f8a53d8 Mar 17, 2026
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants