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

More complete API documentation #87

Open
tmcdonnell87 opened this issue Jan 28, 2017 · 5 comments
Open

More complete API documentation #87

tmcdonnell87 opened this issue Jan 28, 2017 · 5 comments

Comments

@tmcdonnell87
Copy link

Great library. Super useful. However, would love to see some documentation maturity around everything supported.

For example, to read a single resource, I can do fhir.read({ type: 'Patient', id: 'patient-id' }). That's not documented anywhere; you basically have to look at the code/tests to see what's supported.

@niquola
Copy link
Member

niquola commented Jan 28, 2017

Could you help us with docs? ;)

@tmcdonnell87
Copy link
Author

I'll try. Bit crunched for time at the moment, but we'll see if I can find a few hours over the next few weeks. Assume a PR would be easiest?

@niquola
Copy link
Member

niquola commented Jan 30, 2017

Yes, thank you.

@cdaringe
Copy link

maybe something like JSDoc or typings files?

@joeldenning
Copy link
Contributor

I too am wanting this, and am willing to help out with the docs. I'll create a PR with some small additions to the docs. If it goes well, I'll follow up with more PRs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants