-
Notifications
You must be signed in to change notification settings - Fork 42
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
Document cbrain specific boutiques properties (extensions) #1128 #1378
base: master
Are you sure you want to change the base?
Conversation
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.
This doc is good but it has indentations problems (e.g. line 228) and overall it should match the conventions for RDOC blocks. Try to put your new large comment block at the beginning of a method and generate the rdoc with the rake tasks, and inspect the results with yoru browser. Make sure it looks good!
I would prefer all your new methods that end with "custom" in their names ot START with "custom" instead. E.g. instead of allow_empty_strings_custom
, use custom_allow_empty_strings
.
I'll add a few directives to facilitate automated generation of documentation by rdoc, and, following @natacha-beck suggestion, move the property table into a separate file |
…roperty list to html/txt table aces#1128
b92ab38
to
fa39351
Compare
Tested with rdoc 6.6.2, please check now @prioux @natacha-beck |
see #1128