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

SDP: Multi-Medium Data Model #403

Open
joelmartinez opened this issue Jan 10, 2019 · 0 comments
Open

SDP: Multi-Medium Data Model #403

joelmartinez opened this issue Jan 10, 2019 · 0 comments

Comments

@joelmartinez
Copy link
Member

Currently, mdoc's data model is basically the XmlDocument API ... the updater subcommand is tightly coupled with this API for both reading and writing. This project represents the effort to abstract the core data model, and make it so that it can work with multiple on-disk data formats (xml, yaml, etc)

Goals

  • An abstract data model that can be used both to read, and write
  • Easily represent all "alternate" values ... some elements are overload distinctive (return type, name, # of parameters, etc), and some are not (name of parameters, name of generic parameters, attributes).
  • Make it easy to find the "diff" between two API sets.
  • Represent authored content to allow for: importing from tripleslash, and automated content generation ... current tools work directly against the XML, which means they won't easily port to the SDP format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant