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.

Sign up for GitHub

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

Jump to bottom

[Yaml] Document the deprecated arguments of parser and dumper? #6524

Closed
2 tasks done
HeahDude opened this issue May 1, 2016 · 3 comments
Closed
2 tasks done

[Yaml] Document the deprecated arguments of parser and dumper? #6524

HeahDude opened this issue May 1, 2016 · 3 comments
Labels
hasPR A Pull Request has already been submitted for this issue. Waiting feedback Yaml

Comments

@HeahDude
Copy link
Contributor

HeahDude commented May 1, 2016 •
edited by xabbuh
Loading

Trying to start working on #6226 to document the new YAML flags, I'm thinking that maybe we should add a third section to the YAML component doc, something like:

YAML component:

  • Introduction
  • Format
  • Advanced Format Using Flags
    • Parser
    • Dumper

Of courses, I could have post it in the corresponding issue but I noticed that actually this doc is missing in previous version (2.7?), since we can already use some (now deprecated) extra parameters in parse() and dump().

Shouldn't we start by documenting these parameters, then fix #6226 by adding depreciations notices?

Thanks.

EDIT

  • Detail arguments and object parsing,
  • Document objectForMap
@xabbuh
Copy link
Member

xabbuh commented May 2, 2016

Yes, I think it makes sense to document features that were available before with the old way to achieve this first.

@HeahDude HeahDude mentioned this issue May 8, 2016
Closed
@dantleech dantleech mentioned this issue May 21, 2016
Merged
@xabbuh xabbuh added the hasPR A Pull Request has already been submitted for this issue. label May 21, 2016
wouterj added a commit that referenced this issue May 21, 2016
@wouterj
feature #6582 Advanced YAML component usage (dantleech)
9c2a751 
This PR was merged into the 2.3 branch.

Discussion
----------

Advanced YAML component usage

| Q             | A
| ------------- | ---
| Doc fix?      | no
| New docs?     | yes
| Applies to    | 2.3 > 3.0 (i think)
| Fixed tickets | #6524

Prerequisite to #6226

This PR documents the (now deprecated) features for indentation, invalid types and object serialization which have been present since sf 2.3

Commits
-------

3249cbb Advanced YAML component usage
@HeahDude
Copy link
Contributor Author

Still needs a PR in 2.7 for object maps before we can close, I added checkboxes to the description, first checked by #6582.

@HeahDude HeahDude mentioned this issue May 21, 2016
Closed
@xabbuh
Copy link
Member

xabbuh commented May 21, 2016

The second task will be accomplished by #6590.

@xabbuh xabbuh closed this as completed May 21, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hasPR A Pull Request has already been submitted for this issue. Waiting feedback Yaml
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@javiereguiluz @xabbuh @HeahDude