Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add documentation link in Cargo.toml #85

Merged
merged 1 commit into from
Jul 4, 2022
Merged

Add documentation link in Cargo.toml #85

merged 1 commit into from
Jul 4, 2022

Conversation

DJDuque
Copy link
Contributor

@DJDuque DJDuque commented Jun 30, 2022

Whenever you search for openssh in crates.io, this will add a "Documentation" link under the crate's name. This removes the annoying extra click of going into the crate's README if you know you only want to get to the documentation.

@jonhoo
Copy link
Collaborator

jonhoo commented Jun 30, 2022

This change is Reviewable

@NobodyXu
Copy link
Member

Wait, why is it closed?
Did I accidentally close it?

@NobodyXu NobodyXu reopened this Jun 30, 2022
@jonhoo
Copy link
Collaborator

jonhoo commented Jul 2, 2022

Ah, so, this is actually a shortcoming of crates.io: rust-lang/crates.io#1484. I'm hesitant to add a documentation link like that because it'll always point to the latest documentation, which will be wrong if someone is looking at an older version of openssh on crates.io.

@DJDuque
Copy link
Contributor Author

DJDuque commented Jul 2, 2022

That is a fair point, although I believe that the latest documentation is still a reasonable entry point; it reduces the number of clicks needed for everybody. People looking for older versions still need to go README -> Versions -> Select older version -> Documentation link of that older version; here they could just go Latest documentation -> from the top left, choose whatever version.

But leaving out the documentation link is also reasonable.

Copy link
Collaborator

@jonhoo jonhoo left a comment

Choose a reason for hiding this comment

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

Fair enough, I buy that. Let's merge it!

@jonhoo jonhoo merged commit 5203699 into openssh-rust:master Jul 4, 2022
@jonhoo
Copy link
Collaborator

jonhoo commented Jul 4, 2022

Released as 0.9.4 🎉

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants