Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

Document entryPoint and idls options in as-thrift docs #319

Open
andrewdeandrade opened this issue Apr 5, 2016 · 2 comments
Open

Document entryPoint and idls options in as-thrift docs #319

andrewdeandrade opened this issue Apr 5, 2016 · 2 comments

Comments

@andrewdeandrade
Copy link
Contributor

The entryPoint option needs to be documented in the as-thrift documentation. Specifically, we need to call out that relative paths only work with the entryPoint documents.

We should also document the idls option that allows the user to read all the sources themselves and provide them in an object where the keys represent the relative path.

Lastly, it might be worth having a better error when trying to load a file with the source option when the source itself contains relative includes.

@kriskowal

@rajeshsegu
Copy link
Contributor

We have built a library where we feed in the source of the idl file, but all the relative includes fail. I think entryPoint attribute could be useful here. I will try to add documentation in case you guys are ok.

@andrewdeandrade
Copy link
Contributor Author

@rajeshsegu yes, a pull request with documentation would be much appreciated.

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

No branches or pull requests

2 participants