Documentation for variadics#15387
Merged
alice-i-cecile merged 21 commits intobevyengine:mainfrom Oct 2, 2024
Merged
Conversation
Contributor
Author
|
@bash do you know why this isn't working? I added the marker attribute but the documentation doesn't have the new look. |
Contributor
|
@BenjaminBrienen What command did you use to build the docs? There's some |
Contributor
|
Btw |
alice-i-cecile
approved these changes
Sep 23, 2024
Member
Yeah I'm getting an error when attempting to build locally: |
pablo-lua
reviewed
Sep 23, 2024
MrGVSV
suggested changes
Sep 24, 2024
Contributor
Author
|
@alice-i-cecile I'm ready for this to be reviewed again
|
tautropfli
suggested changes
Sep 25, 2024
Contributor
tautropfli
left a comment
There was a problem hiding this comment.
The latest commit still fails for me with with various error: #[doc(fake_variadic)] must be used on the first of a set of tuple or fn pointer trait impls with varying aritys.
I'm using the latest nightly (2024-09-24) and the following command to build: RUSTFLAGS='--cfg docsrs_dep' RUSTDOCFLAGS='--cfg=docsrs' cargo +nightly doc
Maybe the command that you used didn't correctly export the env vars?
set RUSTFLAGS='--cfg docsrs_dep' && set RUSTDOCFLAGS='--cfg=docsrs' && cargo +nightly doc
If you're using fish you can either use the posix-style syntax that I used above or you have to use set -x to get the variable exported iirc.
Contributor
Author
Ah, this command did the trick: Fixing the errors now! |
Contributor
Author
|
The docs generate successfully for me now |
Contributor
Author
|
|
tautropfli
reviewed
Sep 25, 2024
5220d47 to
06a681a
Compare
13ros27
suggested changes
Sep 27, 2024
| @@ -1,4 +1,6 @@ | |||
| #![cfg_attr(docsrs, feature(doc_auto_cfg))] | |||
| // `rustdoc_internals` is needed for `#[doc(fake_variadics)]` | |||
| #![allow(internal_features)] | |||
Contributor
There was a problem hiding this comment.
Should this only be enabled on docsrs and maybe docsrs_dep to prevent the miniscule chance of it accidentally being depended on elsewhere?
Contributor
Author
There was a problem hiding this comment.
That's what I have there, right?
Contributor
There was a problem hiding this comment.
I meant that maybe internal_features should also be under a cfg_attr, should have been clearer
Contributor
|
I'm also unsure where |
Contributor
Author
|
Changes have been cleaned up. No idea how some of that happened lol. |
BenjaminBrienen
commented
Sep 29, 2024
|
|
||
| macro_rules! impl_type_path_tuple { | ||
| ($(#[$meta:meta])*) => { | ||
| $(#[$meta])* |
Contributor
Author
There was a problem hiding this comment.
I can remove this if wanted
Member
|
Can you verify that these are working for It's probably a me thing, since |
13ros27
approved these changes
Sep 29, 2024
Contributor
13ros27
left a comment
There was a problem hiding this comment.
I haven't tried generating the docs myself (afk) but visually it all looks good to me, thanks for fixing the formatting
bushrat011899
approved these changes
Oct 2, 2024
robtfm
pushed a commit
to robtfm/bevy
that referenced
this pull request
Oct 4, 2024
# Objective Relevant: bevyengine#15208 ## Solution I went ahead and added the variadics documentation in all applicable locations. ## Testing - I built the documentation and inspected it to see whether the feature is there.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
Relevant: #15208
Solution
I went ahead and added the variadics documentation in all applicable locations.
Testing