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

docs,fix: Improve error output and documentation clarity in relay ser… #120

Merged
merged 1 commit into from
Dec 23, 2024

Conversation

crStiv
Copy link
Contributor

@crStiv crStiv commented Dec 22, 2024

Changes

This PR includes several improvements to the relay service:

  1. Changed eprint! to eprintln! for error output to ensure proper line breaks in terminal output
  2. Replaced placeholder "TBD" documentation with actual service description
  3. Enhanced RPC endpoint documentation with URL requirements

Motivation

These changes improve developer experience by:

  • Making error messages more readable in the terminal
  • Providing clear and accurate documentation about the service's purpose
  • Adding specific requirements for the RPC endpoint configuration

Impact

These changes are non-functional improvements that only affect documentation and error output formatting. No behavioral changes are introduced.

Copy link
Member

@mattsse mattsse left a comment

Choose a reason for hiding this comment

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

makes sense, ty

@mattsse mattsse merged commit 881c578 into ithacaxyz:main Dec 23, 2024
14 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.

2 participants