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

Polishing Documentation and Comments for Better Clarity #3927

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

donatik27
Copy link

Change Type

  • Bugfix
  • Refactoring (no functional changes, no API changes)
  • Documentation updates

Current Behavior
The current code has the following issues:

Grammatical errors in comments and documentation
Inconsistent comment formatting
Unclear function descriptions

New Behavior
This pull request includes the following changes:

Grammatical corrections: Fixed errors in comments and documentation for better clarity and professionalism.
Improved descriptions: Enhanced the descriptions to make the code's functionality clearer.
Comment organization: Standardized the comment format for consistency across the project.
Note: No functional changes were made to the code.

Thank you for reviewing this PR! 😊

@github-actions github-actions bot added the external Issues created by non node team members label Nov 8, 2024
@@ -89,7 +89,7 @@ func NewBridgeCommand(plugs []node.Plugin) *cobra.Command {
}
```

When starting or initiating a new celestia node, the plugins are passed as settings
When starting or initiating a new сelestia node, the plugins are passed as settings
Copy link
Contributor

Choose a reason for hiding this comment

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

What?

Copy link
Author

Choose a reason for hiding this comment

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

sorry for the inconvenience, that was an accidental fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external Issues created by non node team members
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants