Skip to content

templates/about: mention that "dependencies" key isn't being used yet #318

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

Merged
merged 3 commits into from
Apr 12, 2019
Merged

Conversation

decathorpe
Copy link
Contributor

Adding a comment that the dependencies key in the package.metadata.docs.rs key isn't yet used for builds should clear up some confusion.

Adding a comment that the `dependencies` key in the `package.metadata.docs.rs` key isn't yet used for builds should clear up some confusion.
@decathorpe decathorpe mentioned this pull request Mar 19, 2019
@decathorpe
Copy link
Contributor Author

I'm not a native speaker, so suggestions for improvements are welcome :)

@onur
Copy link
Member

onur commented Mar 22, 2019

I wasn't planning to add/show this feature until we start using it, and we will start using it soon.

@decathorpe
Copy link
Contributor Author

I wasn't planning to add/show this feature until we start using it, and we will start using it soon.

But it IS already documented here, which is leading to confusion: https://docs.rs/about 🤔

@QuietMisdreavus
Copy link
Member

I wasn't planning to add/show this feature until we start using it, and we will start using it soon.

Would you rather we remove the entry entirely from these docs? As @decathorpe mentioned, it is currently being shown on the "About" page.

@onur
Copy link
Member

onur commented Mar 29, 2019

Yes looks like its been added with #196, I didn't realize dependencies until this PR sorry 🤢

It's better if we remove that section until we start using it.

@QuietMisdreavus
Copy link
Member

Revisiting this PR. I agree with #318 (comment) - it's best to remove it from documentation entirely until it becomes useful. Can you update the file to remove that entry from the page?

Copy link
Member

@QuietMisdreavus QuietMisdreavus left a comment

Choose a reason for hiding this comment

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

Thanks so much!

@QuietMisdreavus QuietMisdreavus merged commit 54fff31 into rust-lang:master Apr 12, 2019
@QuietMisdreavus
Copy link
Member

And it's live! https://docs.rs/about

@decathorpe
Copy link
Contributor Author

Thanks! 😄

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.

3 participants