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

Include crate features in docs #286

Merged
merged 5 commits into from Oct 20, 2019
Merged

Conversation

@Hofer-Julian
Copy link
Contributor

Hofer-Julian commented Oct 6, 2019

Fixes #285

Julian Hofer added 2 commits Oct 6, 2019
Julian Hofer
Julian Hofer
@Hofer-Julian Hofer-Julian changed the title WIP: include crate features in docs Include crate features in docs Oct 18, 2019
@Hofer-Julian

This comment has been minimized.

Copy link
Contributor Author

Hofer-Julian commented Oct 18, 2019

From my side this pull request would be finished.
If something needs to be changed please let me know.

src/lib.rs Outdated Show resolved Hide resolved
@EPashkin

This comment has been minimized.

Copy link
Member

EPashkin commented Oct 18, 2019

@Hofer-Julian Thanks, 👍

Julian Hofer
@@ -2,6 +2,66 @@
// See the COPYRIGHT file at the top-level directory of this distribution.
// Licensed under the MIT license, see the LICENSE file or <http://opensource.org/licenses/MIT>

//! # Cairo bindings
//!
//! This library contains safe Rust bindings for [Cairo](https://www.cairographics.org/).

This comment has been minimized.

Copy link
@GuillaumeGomez

GuillaumeGomez Oct 20, 2019

Member

Why the two extra whitespaces at the beginning?

This comment has been minimized.

Copy link
@Hofer-Julian

Hofer-Julian Oct 20, 2019

Author Contributor

Readability?
But if the convention differs, I will remove them.

This comment has been minimized.

Copy link
@GuillaumeGomez

GuillaumeGomez Oct 20, 2019

Member

It's markdown so they'll get removed. And it makes the doc comment looking strange. It'd be nice to remove then if you don't mind. :)

This comment has been minimized.

Copy link
@Hofer-Julian

Hofer-Julian Oct 20, 2019

Author Contributor

Done!
I removed quite a lot of whitespace.
If you want some back just tell me.

src/lib.rs Outdated
//! ### Fileformat features
//!
//! * **png** -
//! Reading and writing PNG images

This comment has been minimized.

Copy link
@GuillaumeGomez

GuillaumeGomez Oct 20, 2019

Member

Why putting it on a newline?

This comment has been minimized.

Copy link
@Hofer-Julian

Hofer-Julian Oct 20, 2019

Author Contributor

No particular reason, I can remove them as well.

This comment has been minimized.

Copy link
@GuillaumeGomez

GuillaumeGomez Oct 20, 2019

Member

Yes please!

This comment has been minimized.

Copy link
@GuillaumeGomez

GuillaumeGomez Oct 20, 2019

Member

What I meant was to write it this: * **png** - Reading and writing PNG images

This comment has been minimized.

Copy link
@Hofer-Julian

Hofer-Julian Oct 20, 2019

Author Contributor

Done!
It looks indeed better

Julian Hofer added 2 commits Oct 20, 2019
Julian Hofer
Julian Hofer
@Hofer-Julian

This comment has been minimized.

Copy link
Contributor Author

Hofer-Julian commented Oct 20, 2019

I noticed that rust-fmt made a small change.
Should I remove it?

@GuillaumeGomez

This comment has been minimized.

Copy link
Member

GuillaumeGomez commented Oct 20, 2019

No, don't worry about it. I'm looking at why the doc checker isn't happy.

@GuillaumeGomez

This comment has been minimized.

Copy link
Member

GuillaumeGomez commented Oct 20, 2019

Well whatever, merging. Thanks!

@GuillaumeGomez GuillaumeGomez merged commit d6ea866 into gtk-rs:master Oct 20, 2019
0 of 2 checks passed
0 of 2 checks passed
continuous-integration/appveyor/pr Waiting for AppVeyor build to complete
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
@Hofer-Julian Hofer-Julian deleted the Hofer-Julian:Feature-Docs branch Oct 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.