-
Notifications
You must be signed in to change notification settings - Fork 216
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
To fix documentation headers. #1325
base: develop
Are you sure you want to change the base?
Conversation
Signed-off-by: Chaurasiya, Payal <[email protected]>
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.
Thanks for volunteering for this change. Beyond our offline discussion, I have two suggestions:
- Can we remove
Class
word in class templates (module is ok though)? Feels cleaner IMO. - How about disabling the "sidebar" when viewing a class/function definition? That will free up real estate even for expanded definitions written below the title.
P.S.: Verify that function
pages do not show Class
or Module
word.
Signed-off-by: Chaurasiya, Payal <[email protected]>
Signed-off-by: Chaurasiya, Payal <[email protected]>
Signed-off-by: Chaurasiya, Payal <[email protected]>
@MasterSkepticista Currently module name and class names are very similar. So I feel its better to have Class/Module/Function in title. |
Signed-off-by: Chaurasiya, Payal <[email protected]>
Link post changes - https://payalcha-openfl.readthedocs.io/en/latest/
What we changed -
All custom module will be prefixed with Module -
All Classes will be prefixed with Class -
All Functions will be prefixed with Function-