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

Library/Emitter authoring documentation is not usable #2728

Closed
tjprescott opened this issue Dec 4, 2023 · 0 comments · Fixed by #2725
Closed

Library/Emitter authoring documentation is not usable #2728

tjprescott opened this issue Dec 4, 2023 · 0 comments · Fixed by #2725
Assignees
Labels
docs Improvements or additions to documentation triaged:core

Comments

@tjprescott
Copy link
Member

I was asked to create an emitter in a fresh repo using the emitter framework. I have been trying to follow the directions here and they simply do not work as written.

Fundamentally, if I'm writing an emitter (or library) I want to be able to do three things:

  1. compile my code
  2. write tests so I can do test-driven development
  3. debug into those tests since it's preferable to creating a bunch of manual test files and debugging into those

There are several small issues in the documentation like typos, but there are larger ones.

  • The whole first section about setting things up becomes inaccurate once you try to set up testing in a section below. But the testing section doesn't actually correctly address what needs to be adjusted from the earlier section.
  • The testing section doesn't provide guidance on how to set up testing, so the third priorty (debugging into tests) is totally absent

This is all before I can even get to the whole point of this exercise, which is to use the emitter framework.

As someone who has been working on TypeSpec for over a year, if it is this difficult to get set up, I don't see how we could expect our customers to find success.

@tjprescott tjprescott added the docs Improvements or additions to documentation label Dec 11, 2023
@tjprescott tjprescott added this to the [2024] January milestone Dec 11, 2023
tjprescott added a commit that referenced this issue Dec 14, 2023
Fixes #2728.

---------

Co-authored-by: Timothee Guerin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation triaged:core
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants