-
Notifications
You must be signed in to change notification settings - Fork 123
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
doc(stdlib): doc comments for BaseTrait
#1296
doc(stdlib): doc comments for BaseTrait
#1296
Conversation
…o separate file with new documentation
what issue is it solving? |
I would argue |
#573 |
Yeah, if this file layout is ok, I'll rename this file to There are now also functions like |
this is exactly what I'm arguing against:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep the changes for base.tact
and revert the rest of them until we have a clear plan
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice job overall, I've only edited descriptions to match the rest of ///
comments and their original source — the docs.
…lder-base-trait # Conflicts: # src/imports/stdlib.ts
BaseTrait
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but let's give @novusnota the chance to comment
This PR adds more documentation, as an example of the level I would like to see for the entire standard library!
The new documentation for
BaseTrait
shows how we document code in general.///
for documentation commentsI think we need an RFC in which we will describe all such rules that everyone in the team agrees with. Everything described above is negotiable and I will be glad to hear your thoughts on how to further change and improve the documentation rules!
Towards #573