Say what syck does in the readme #49
Merged
Conversation
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
headius
approved these changes
Mar 20, 2025
headius
left a comment
headius
left a comment
There was a problem hiding this comment.
Looks good to me. I don't care much about the long lines (80 columns is so 20th century) but if there's any such standard it should be followed.
README.rdoc
Outdated
|
|
||
| A gemified version of Syck from Ruby's stdlib. Syck has been removed from | ||
| Ruby's stdlib, and this gem is meant to bridge the gap for people that haven't | ||
| This Gem is a wrapper around {Syck}[https://github.com/indeyets/syck] (a.k.a. Scripters' YAML Cobble-Yourself-a-Parser Kit), |
There was a problem hiding this comment.
Dunno if there's any standard for markdown content in projects under the ruby org but perhaps this text should try to match the 80-column wrapping of the original content?
Contributor
Author
There was a problem hiding this comment.
Done! Agree it's probably not necessary in this day and age, but changed nonetheless
headius
approved these changes
Mar 22, 2025
|
Thanks for the doc update! It's fun to see this old ibrary and get some attention because we implemented the same API in yecht for JRuby and then it just faded from memory. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Was pretty confused by this myself until looking into it further. Ideally, the readme should have this kind of info.
Please feel free to suggest any improvements to what I've proposed! :)
Fixes #32