Skip to content

Move default docs#9638

Merged
alice-i-cecile merged 3 commits intobevyengine:mainfrom
ameknite:move-default-docs
Aug 30, 2023
Merged

Move default docs#9638
alice-i-cecile merged 3 commits intobevyengine:mainfrom
ameknite:move-default-docs

Conversation

@ameknite
Copy link
Copy Markdown
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
rdrpenguin04 pushed a commit to rdrpenguin04/bevy that referenced this pull request Jan 9, 2024
# 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

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

Development

Successfully merging this pull request may close these issues.

3 participants