You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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 likesort_base_mapping_type_on_output
are very useful, undocumented inruamel.yaml
, and have no PyYAML equivalent AFAICT. So for this and the other attributes that fulfill these criteria, we should add some docs.The text was updated successfully, but these errors were encountered: