#8 Please improve documentation. How do I use this thing?

[Gabriel P]

I just want to reindent folder with existing yaml files and reading your entry nor output of yaml -h I am none the smarter. Please document some examples. Further explanation of options like rt , me etc should also be done. Current one talks about round trips, while I have no idea where did that come from in context of yaml files, I know about round trips in networks only.

[Anthon van der Neut]

Essentially a round trip is where you get back to where you were: you have YAML document in a file; load the document into data; make some changes; dump the data back into a file as YAML document. At the end you are back where you started. Using its round-trip mode ruamel.yaml tries to preserve comments, tags and other things during such a round-trip. (A bit of googling would show you that the documentation for the ruamel.yaml package underlying this commandline utility uses that term repeatedly).

Your comment about documentation is noted and valid but until I have time to work on ruamel.yaml again for some continuous days, please post a specific question on what you would want to achieve with ruamel.yaml.cmd on stackoverflow. (provide input, expected output) If you tag the question with ruamel.yaml, I'll get notified automatically and answer (normally with not too much of a delay). And if it can't be done with ruamel.yaml.cmd (i.e. the yaml command), but can be done with ruamel.yaml you are very likely to get a python program that does what you want in the answer.

[Gabriel P]

Are you sure question regarding CLI tool won't get down? Stackoverflow is primarily for code questions. but I am not writing a code here hence can not provide code snippet. I'm afraid such question might be just taken down and I would be redirected to e.g. superuser forum.

[Anthon van der Neut]

You might be right. But if you would present it as a YAML transformation, showing what you wanted to do it should be right. Have you tried yaml rt --help resp. yaml rt --save <filename>?