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

Referring to an enum from prose #118

Open
annevk opened this issue Oct 2, 2018 · 2 comments
Open

Referring to an enum from prose #118

annevk opened this issue Oct 2, 2018 · 2 comments

Comments

@annevk
Copy link

annevk commented Oct 2, 2018

"Background fetch response" refers directly to an IDL enum from prose, expecting the reader to expand it. I'm not aware of any precedent for that and interweaving IDL with prose like that seems a little weird.

I'd prefer if we kept some separation between the model and the external API.

@jakearchibald
Copy link
Collaborator

Is the best thing to do here to repeat the values in each place? That's what I was trying to avoid.

@annevk
Copy link
Author

annevk commented Oct 2, 2018

Yeah, model/prose values and IDL values. I guess we could try to figure out a new model for this, but the bit of duplication doesn't hurt that much I think.

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

2 participants