-
Notifications
You must be signed in to change notification settings - Fork 311
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
Use box drawing art for illustrating an example for ArrayView::split_at #565
Conversation
High priority items we can illustrate:
@jturner314 What do you think? Too ugly and unprofessional or pragmatic? Using boxes is not exactly flexible, can't color anything, but the boxes by themselves look surprisingly sharp. |
Text has a lot of practical advantages – easy to edit, doesn't require any special software to edit, works nicely with version control, integrates well into existing docs, and makes it easy to maintain a consistent style. The best alternative would be SVG (which can be edited with Inkscape and included directly as an image), but then the images would be in separate files from the docs, hosting them would be more difficult, they wouldn't be as easy to edit/diff, and keeping the style consistent would be more difficult. Plain text doesn't look as nice as SVG images and is somewhat limiting, but IMO the practical advantages outweigh the disadvantages. By the way, I do have a few minor suggestions about the sample drawing:
|
c5bf167
to
9813e31
Compare
64af1b1
to
054d979
Compare
Rebased & resolved conflict |
…plit_at This is a proof of concept. Box drawings are relatively easy to produce, easy to distribute and maintain in all places rustdoc renders, readable in plain text and when rendered, and they have a consistent style. The biggest positive is that it enables us to produce many illustrations. They have the drawback that they restrict us to mostly 2-D (but that makes for easier to understand illustrations anyway), and it doesn't look very impressive.
054d979
to
2ab3e9e
Compare
Let's go, one less PR in the queue :) |
This is a proof of concept.
Temporarily hosting the docs on github pages see the ArrayView::split_at example there.
Box drawings are relatively easy to produce, easy to distribute and
maintain in all places rustdoc renders, readable in plain text and
when rendered, and they have a consistent style.
The biggest positive is that it enables us to produce many
illustrations.
They have the drawback that they restrict us to mostly 2-D (but that makes
for easier to understand illustrations anyway), and it doesn't look very
impressive.