-
Notifications
You must be signed in to change notification settings - Fork 2
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
Provide proper documentation on API #94
Comments
Hi @opoudjis @ronaldtse Model documentation is available at https://rubydoc.info/github/lutaml/expressir/master/Expressir/Model - let me know if there is anything to improve. I'm not sure what does "complete, unformatted schema listing from a schema" mean. |
If you are looking for a method to generate source code, this method accepts any model instance https://rubydoc.info/github/lutaml/expressir/master/Expressir/Express/Formatter#format-class_method |
@zakjan can we have:
Could we supplement this with the actual text from the document? |
I can update readme and add most common examples, does it help? Readme is obsolete anyway, I focused on the functionality and YARD docs, haven't touched readme at all yet. Config/Configure is a remnant of the previous version, unfortunately I have no idea how it was supposed to be used. I can delete it.
The output from Parser.parse is Repository, all children can be traversed down. I'm not sure what more to add. I'll make sure there is an example in the readme.
I can copy there the entire section text from PDF spec as-is, manually formatted. Is it ok to make it publicly available with your license? Alternatively, is there an online version of the spec to link to? |
From @opoudjis :
https://github.com/metanorma/annotated-express/issues/18
Please help with this, thanks @zakjan
The text was updated successfully, but these errors were encountered: