docs(readme): correct usage examples#899
Merged
Merged
Conversation
## What - Replaced stale README references to the nonexistent `Nonnative::EchoServer` with the example `Nonnative::TCPServer` class. - Clarified Go documentation so programmatic binaries use normal argv process commands while YAML `go:` config is documented as the `go test -c` helper path. - Updated Go build tags, split YAML parameters into argv entries, and cleaned up README wording. ## Why - Keep README examples aligned with the current public configuration API and argv execution behavior. ## Testing - `git diff --check` - passed - `make lint` - passed - `bundle exec cucumber features/command.feature` - passed
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #899 +/- ##
=======================================
Coverage 99.62% 99.62%
=======================================
Files 35 35
Lines 806 806
=======================================
Hits 803 803
Misses 3 3
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Nonnative::EchoServerwith the exampleNonnative::TCPServerclass.go:config is documented as thego test -chelper path.Why
Testing
git diff --check- passedmake lint- passedbundle exec cucumber features/command.feature- passed