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

Add missing links and examples #45582

Merged
merged 1 commit into from Nov 8, 2017

Conversation

GuillaumeGomez
Copy link
Member

r? @rust-lang/docs

@frewsxcv
Copy link
Member

looks like you have some broken links

@kennytm kennytm added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Oct 28, 2017
@GuillaumeGomez
Copy link
Member Author

Indeed. I'll fix this as soon as I can.

/// let file_type = meta.file_type();
/// assert!(file_type.is_block_device());
/// # Ok(())
/// # }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing closing ``` for all of these examples.

@GuillaumeGomez
Copy link
Member Author

Added missing ```.

/// Unix-specific extensions to `File`
/// Unix-specific extensions to [`File`].
///
/// [`File`]: ../../../std/fs/struct.File.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are still broken links (not enough ../)

[01:12:39] std/os/unix/fs/trait.DirEntryExt.html:54: broken link - std/std/fs/struct.DirEntry.html

[01:12:39] std/os/unix/fs/index.html:59: broken link - std/std/fs/struct.DirBuilder.html

[01:12:39] std/os/unix/fs/index.html:66: broken link - std/std/fs/struct.DirEntry.html

[01:12:39] std/os/unix/fs/index.html:73: broken link - std/std/fs/struct.File.html

[01:12:39] std/os/unix/fs/trait.FileExt.html:55: broken link - std/std/fs/struct.File.html

[01:12:39] std/os/unix/fs/trait.DirBuilderExt.html:54: broken link - std/std/fs/struct.DirBuilder.html

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot a .. once again...

@GuillaumeGomez
Copy link
Member Author

Fixed.

@kennytm kennytm added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 5, 2017
///
/// ```
/// use std::fs;
/// use std::os::unix::prelude::FileTypeExt;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you import the trait from std::os::unix::fs::FileTypeExt instead?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same goes for the other imports in these examples

Copy link
Member

@frewsxcv frewsxcv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

r=me with @QuietMisdreavus's comment (and maybe mine) addressed. nice work! ✨

@@ -269,19 +271,79 @@ impl MetadataExt for fs::Metadata {
fn blocks(&self) -> u64 { self.st_blocks() }
}

/// Add special unix types (block/char device, fifo and socket)
/// Add special unix types (block/char device, fifo and socket).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

onder if this might be better worded as:

/// Add support for special unix types (block/char device, fifo and socket).

///
/// ```
/// use std::fs;
/// use std::os::unix::prelude::FileTypeExt;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same goes for the other imports in these examples

@kennytm kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 7, 2017
@GuillaumeGomez
Copy link
Member Author

@bors: r=frewsxcv rollup

@bors
Copy link
Contributor

bors commented Nov 8, 2017

📌 Commit cef0573 has been approved by frewsxcv

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request Nov 8, 2017
…ks, r=frewsxcv

Add missing links and examples

r? @rust-lang/docs
@kennytm kennytm added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Nov 8, 2017
bors added a commit that referenced this pull request Nov 8, 2017
Rollup of 4 pull requests

- Successful merges: #45582, #45766, #45830, #45849
- Failed merges:
@bors bors merged commit cef0573 into rust-lang:master Nov 8, 2017
@GuillaumeGomez GuillaumeGomez deleted the doc-unix-missing-links branch November 8, 2017 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants