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

Add JSDoc comments #582

Merged
merged 5 commits into from
Aug 29, 2019
Merged

Add JSDoc comments #582

merged 5 commits into from
Aug 29, 2019

Conversation

Ryuno-Ki
Copy link
Contributor

Hi @zachleat,

just want to get your feedback on this before I invest too much time into it.
Would you accept JSDoc comments in your code?

This way, editors would be able to suggest Autocomplete, you could use them for typing with flow and you can render documentation for the implementation.

I can't speak for others, but I find it sometimes difficult to understand, what's going on.

Since I document my Node.js projects, I developed some opinions.
For example, using ink-docstrap for rendering more appealing JSDoc html files.

Read more about JSDoc online (old URL was usejsdoc).

@kleinfreund
Copy link
Contributor

Yes, I assume that's welcome. I documented code in my contributions with JSDoc, too.

@Ryuno-Ki Ryuno-Ki changed the title WIP: Add JSDoc comments Add JSDoc comments Jun 28, 2019
@Ryuno-Ki
Copy link
Contributor Author

Okay, since I got a positive comment + a 👍, I added docstrings to the rest of Eleventy class.
More will follow after this one get merged in.

Would help if somebody could update the _tbd._s after a merge 😅
Wasn't completely sure, what the code is supposed to do (another positive side effect when adding documentation: it forces you to write cleaner code :-D )

src/Eleventy.js Outdated Show resolved Hide resolved
@Ryuno-Ki
Copy link
Contributor Author

@zachleat Is there something blocking this from being merged?

Ryuno-Ki and others added 4 commits August 2, 2019 22:10
@zachleat zachleat merged commit 44b0afe into 11ty:master Aug 29, 2019
@zachleat
Copy link
Member

Thanks for this @Ryuno-Ki!

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

Successfully merging this pull request may close these issues.

4 participants