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

JSDOM vs JSDOC confusion #6

Closed
rub1e opened this issue Nov 2, 2018 · 3 comments
Closed

JSDOM vs JSDOC confusion #6

rub1e opened this issue Nov 2, 2018 · 3 comments
Labels
good first issue Good for newcomers question Further information is requested technical

Comments

@rub1e
Copy link
Member

rub1e commented Nov 2, 2018

Minor point, but the first appearance of JSDOC threw me a bit as it hadn't been referred to before and I just read it as JSDOM

Suggest changing "Testing" heading to "Testing & Documentation" and adding a line saying "We will use JSDOC for documentation" with a link to https://github.com/dwyl/learn-jsdoc

Let me know what you think and I'll do a PR if you think this is a useful clarification

@nelsonic
Copy link
Member

nelsonic commented Nov 2, 2018

@rub1e great points; thanks for taking a look at this with a fresh pair of eyes. 🙌
If you have time to PR an update would be great to clarify JSDOC vs. JSDOM and link to the other repo for more detail. 👍🏻

@nelsonic nelsonic added good first issue Good for newcomers question Further information is requested technical labels Nov 2, 2018
@rub1e
Copy link
Member Author

rub1e commented Nov 2, 2018

Yeah I was just zipping through it while avoiding my own work - I'll go through it properly when I have the chance - keen to learn TEA!

PR: #7

@nelsonic
Copy link
Member

nelsonic commented Nov 3, 2018

@rub1e thanks for the PR clarifying JSDOC vs JSDOM. 🎉
Our hope is that this tutorial will show complete beginners 🌱 & TDD-doubers in the JS community 🌍
that TDD is not only viable, it's easy and efficient once you you get a bit of an intro and practice. 🚀
Look forward to hearing your feedback when you get a chance to go through the full example. 💬

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers question Further information is requested technical
Projects
None yet
Development

No branches or pull requests

2 participants