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.

Sign up for GitHub

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

Jump to bottom

Move default docs #9638

Merged
merged 3 commits into from
Aug 30, 2023
Merged

Move default docs #9638

merged 3 commits into from
Aug 30, 2023

Conversation

ameknite
Copy link
Contributor

Objective

Solution

  • Move the documentation to the fn default() method instead of the impl Default.

Allows you to view the docs directly on the function without having to go to the implementation.

Before

Screenshot 2023-08-29 at 18 21 03

After

Screenshot 2023-08-29 at 18 19 54

@JMS55 JMS55 added the C-Docs An addition or correction to our documentation label Aug 30, 2023
@alice-i-cecile alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Aug 30, 2023
@alice-i-cecile alice-i-cecile added the A-Utils Utility functions and types label Aug 30, 2023
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Aug 30, 2023
Merged via the queue into bevyengine:main with commit fb094ea Aug 30, 2023
24 checks passed
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
@ameknite
Move default docs (bevyengine#9638)
f949b89 
# Objective

- Make the default docs more useful like suggested in
bevyengine#9600 (comment)

## Solution

- Move the documentation to the `fn default()` method instead of the
`impl Default`.

Allows you to view the docs directly on the function without having to
go to the implementation.

### Before
![Screenshot 2023-08-29 at 18 21
03](https://github.com/bevyengine/bevy/assets/104745335/6d31591e-f190-4b8e-8bc3-a570ada294f0)

### After
![Screenshot 2023-08-29 at 18 19
54](https://github.com/bevyengine/bevy/assets/104745335/e2442ec1-593d-47f3-b539-8c77a170f0b6)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JMS55 JMS55 JMS55 approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-Utils Utility functions and types C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ameknite @alice-i-cecile @JMS55