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: where are the rest? #29

Open
dougpagani opened this issue Dec 7, 2020 · 1 comment
Open

Docs: where are the rest? #29

dougpagani opened this issue Dec 7, 2020 · 1 comment
Labels
docs This issue/PR relates to or includes documentation. help wanted Extra attention is needed

Comments

@dougpagani
Copy link

dougpagani commented Dec 7, 2020

Hi, I found this project based-off a coincidence of the same fact of this fork's creation -- I'm trying to use github (actions). As far as I can tell, ruamel is the only roundtrip parser (at least so far as preserving comments goes) that exists in the world. For context, I'm trying to build a preprocessor that dereferences & strips aliases for Github Actions, but preserves everything else to the best of this project's dumper's ability. I just want to know what that ability is, and where I'll have to "lint" to get the closest roundtrip conversion possible.

I looked through the docs, and to the best of my knowledge, they seem to be a bit incomplete. This is really a brief question -- where are the configuration options for the dumper? I came across this post so I know it is possible, and looked through the docs, but cannot find a corresponding section from which I'd be able to find it by RTFM'ing.

Is this a RTFSC situation, or are there more docs in some other kind of format?

@dougpagani
Copy link
Author

dougpagani commented Dec 7, 2020

I realized a SO tag may be a good start for finding information:
https://stackoverflow.com/questions/tagged/ruamel.yaml
Or, with the apparent original author of this parser included in the search:
https://stackoverflow.com/search?q=user:1307905+[ruamel.yaml]

@gdubicki gdubicki added docs This issue/PR relates to or includes documentation. help wanted Extra attention is needed labels Dec 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This issue/PR relates to or includes documentation. help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants