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

To fix documentation headers. #1325

Draft
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

payalcha
Copy link
Contributor

@payalcha payalcha commented Jan 30, 2025

Link post changes - https://payalcha-openfl.readthedocs.io/en/latest/

What we changed -
All custom module will be prefixed with Module -

image

All Classes will be prefixed with Class -

image

All Functions will be prefixed with Function-
image

Signed-off-by: Chaurasiya, Payal <[email protected]>
@payalcha payalcha marked this pull request as draft January 30, 2025 14:22
Copy link
Collaborator

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

@payalcha
Copy link
Contributor Author

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.

@MasterSkepticista Currently module name and class names are very similar. So I feel its better to have Class/Module/Function in title.
SideBar - We can keep it for now.

Signed-off-by: Chaurasiya, Payal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants