8000 docs: add documentation for NewUnsyncLocalClient and other ABCI clients by VolodymyrBg · Pull Request #5017 · cometbft/cometbft · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: add documentation for NewUnsyncLocalClient and other ABCI clients #5017

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Mar 21, 2025
Merged

docs: add documentation for NewUnsyncLocalClient and other ABCI clients #5017

merged 13 commits into from
Mar 21, 2025

Conversation

VolodymyrBg
Copy link
Contributor
@VolodymyrBg VolodymyrBg commented Mar 5, 2025 •
edited by melekes
Loading

Closes #4785

This PR addresses #4785 by adding comprehensive documentation for ABCI clients, focusing on NewUnsyncLocalClient. The changes include:

  1. Created a new documentation file (docs/explanation/core/abci-clients.md) that explains:

    • Overview of available ABCI client types
    • Detailed documentation for each local client variant
    • When to use UnsyncLocalClient
    • Usage examples and performance considerations

  2. Updated docs/explanation/core/README.md with a link to the new documentation

  3. Enhanced the inline code documentation in abci/client/unsync_local_client.go:

    • Added more details about when to use this client
    • Added cross-references to related documentation
    • Provided specific use cases

  4. Added a changelog entry under improvements

These changes provide comprehensive documentation for users to understand the purpose of NewUnsyncLocalClient and how it differs from other ABCI client implementations.

@VolodymyrBg VolodymyrBg requested review from a team as code owners March 5, 2025 18:40
melekes
melekes approved these changes Mar 6, 2025
View reviewed changes
Copy link
Contributor
@melekes melekes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@VolodymyrBg
Copy link
Contributor Author

@melekes I corrected a lint mistake

@VolodymyrBg VolodymyrBg requested a review from melekes March 6, 2025 12:46
@VolodymyrBg
Copy link
Contributor Author

@melekes, please check it one more time when you have a free moment. There was a lint mistake so it wasn't merged

@melekes melekes added this pull request to the merge queue Mar 21, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Mar 21, 2025
@melekes melekes enabled auto-merge March 21, 2025 10:38
@melekes melekes added this pull request to the merge queue Mar 21, 2025
Merged via the queue into cometbft:main with commit e820315 Mar 21, 2025
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@melekes melekes melekes approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add documentation for NewUnsyncLocalClient
2 participants
@VolodymyrBg @melekes
0