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

Document cbrain specific boutiques properties (extensions) #1128 #1378

Open
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

MontrealSergiy
Copy link
Contributor

see #1128

Copy link
Member

@prioux prioux left a 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.

@MontrealSergiy
Copy link
Contributor Author

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

@MontrealSergiy MontrealSergiy changed the base branch from master to dev March 7, 2024 22:04
@MontrealSergiy MontrealSergiy changed the base branch from dev to master March 7, 2024 22:15
@MontrealSergiy
Copy link
Contributor Author

Tested with rdoc 6.6.2, please check now @prioux @natacha-beck

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document somewhere the special cbrain flag for Boutiques descriptors
2 participants