-
Notifications
You must be signed in to change notification settings - Fork 117
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 better documentation for BaseTrait and Builder #1296
base: main
Are you sure you want to change the base?
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:
|
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 commentsself
referring to the current contract/traitThe documentation for
Builder
shows the following aspects:builder.tact
forBuilder
for example), where at the very beginning there is a definition of theprimitive Builder;
type with a comment attached explaining what it is and examples of use.# Example
, this will allow automatic generation/display of headers in documentation and IDE, which should improve readability.@since 1.5.0
as in other languages.I 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!
#573