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

FilterType: Add examples and timings to docs #1040

Merged
merged 1 commit into from
Jan 4, 2020
Merged

FilterType: Add examples and timings to docs #1040

merged 1 commit into from
Jan 4, 2020

Conversation

dbrgn
Copy link
Contributor

@dbrgn dbrgn commented Sep 23, 2019

Preview:

img

Unfortunately Rustdoc does not provide a simple method to include images in the docs (see rust-lang/rust#32104). I quickly considered including them as inline base64, but that would add a huge amount of text to the enum documentation. Instead, I linked to them from GitHub.

This means that when doing local changes, these need to be previewed by manually replacing the github URL with a relative link (../../../docs/). However, it should work on docs.rs.

I license past and future contributions under the dual MIT/Apache-2.0 license,
allowing licensees to chose either at their option.

@HeroicKatora
Copy link
Member

HeroicKatora commented Sep 23, 2019

If I understand the changes then these images would be included in the distributed crate. This will bloat it quite a bit, from ~150 kB to roughly 5 times that amount. You do seem think that is worth the documentation clarity. That doesn't seem as obvious to me, so maybe you can tell me why? Are there alternatives that could avoid that downside?

@dbrgn
Copy link
Contributor Author

dbrgn commented Sep 23, 2019

Ah, I think you're right that the docs directory is being included in the crate. I wasn't aware of that. We could move the pictures into the examples directory, which is excluded in Cargo.toml.

@HeroicKatora
Copy link
Member

Triage: It seems clear how to address the requested changes. Is there some hold-up?

@dbrgn
Copy link
Contributor Author

dbrgn commented Jan 4, 2020

@HeroicKatora fixed!

@HeroicKatora HeroicKatora merged commit 0aaef55 into image-rs:master Jan 4, 2020
@HeroicKatora
Copy link
Member

Thank you :)

@dbrgn dbrgn deleted the filter-type-examples branch January 4, 2020 19:31
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.

2 participants