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

Systematic documentation for YAML object attributes #14

Open
smheidrich opened this issue Sep 25, 2020 · 2 comments
Open

Systematic documentation for YAML object attributes #14

smheidrich opened this issue Sep 25, 2020 · 2 comments
Labels
docs This issue/PR relates to or includes documentation.

Comments

@smheidrich
Copy link

Thanks for this fork, I couldn't be bothered to navigate SourceForge's horrible UI in 2020 just to report this:

The documentation for the various attributes that can be set on YAML objects to influence the library's behavior is quite sparse/nonexistent. Some of these options were just carried over from PyYAML, so perhaps for those it's not necessary to have extra documentation here, but e.g. things like sort_base_mapping_type_on_output are very useful, undocumented in ruamel.yaml, and have no PyYAML equivalent AFAICT. So for this and the other attributes that fulfill these criteria, we should add some docs.

@jwilson8767
Copy link
Collaborator

Thanks for creating this issue! I, too, have been annoyed by the lack of documentation and hope we can improve exactly this sort of thing! We're still working on migrating the existing docs to a more useful form, but in the meantime if you wanted to drop literally any comments onto some of those attributes and submit a PR, it would be really helpful!

Heck, if you even take a few minutes to type up the options you have found helpful in the past I'll make a point to make sure they end up in docs in the future.

@lyz-code
Copy link
Collaborator

I don't know where to put it in the docs, so I'm adding here a table and I'll go on completing it while I use the library:

YAML() attributes:

Property Type Description
explicit_start boolean Add --- at the start of the source
sequence_indent int

@gdubicki gdubicki added the docs This issue/PR relates to or includes documentation. label 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.
Projects
None yet
Development

No branches or pull requests

4 participants