From e3ec751a3f022b6b6591e63b9a1dd395dd5409b8 Mon Sep 17 00:00:00 2001 From: Bas Bossink Date: Sun, 19 May 2019 22:16:10 +0200 Subject: [PATCH] Issue 703 (#929) * Replace all occurances of altenate backend with alternative backed Rename test for consistency of the terminology. * Use better sed command --- book-example/src/SUMMARY.md | 2 +- book-example/src/for_developers/README.md | 2 +- book-example/src/for_developers/backends.md | 8 ++++---- src/config.rs | 2 +- tests/{alternate_backends.rs => alternative_backends.rs} | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) rename tests/{alternate_backends.rs => alternative_backends.rs} (97%) diff --git a/book-example/src/SUMMARY.md b/book-example/src/SUMMARY.md index 8c03a750..4aab90f3 100644 --- a/book-example/src/SUMMARY.md +++ b/book-example/src/SUMMARY.md @@ -20,7 +20,7 @@ - [Continuous Integration](continuous-integration.md) - [For Developers](for_developers/README.md) - [Preprocessors](for_developers/preprocessors.md) - - [Alternate Backends](for_developers/backends.md) + - [Alternative Backends](for_developers/backends.md) ----------- diff --git a/book-example/src/for_developers/README.md b/book-example/src/for_developers/README.md index 00c8c438..1605818a 100644 --- a/book-example/src/for_developers/README.md +++ b/book-example/src/for_developers/README.md @@ -12,7 +12,7 @@ The *For Developers* chapters are here to show you the more advanced usage of The two main ways a developer can hook into the book's build process is via, - [Preprocessors](preprocessors.md) -- [Alternate Backends](backends.md) +- [Alternative Backends](backends.md) ## The Build Process diff --git a/book-example/src/for_developers/backends.md b/book-example/src/for_developers/backends.md index 891c8355..7ab3a607 100644 --- a/book-example/src/for_developers/backends.md +++ b/book-example/src/for_developers/backends.md @@ -1,4 +1,4 @@ -# Alternate Backends +# Alternative Backends A "backend" is simply a program which `mdbook` will invoke during the book rendering process. This program is passed a JSON representation of the book and @@ -14,7 +14,7 @@ rough example of how this is accomplished in practice. - [mdbook-test] - a program to run the book's contents through [rust-skeptic] to verify everything compiles and runs correctly (similar to `rustdoc --test`) -This page will step you through creating your own alternate backend in the form +This page will step you through creating your own alternative backend in the form of a simple word counting program. Although it will be written in Rust, there's no reason why it couldn't be accomplished using something like Python or Ruby. @@ -140,7 +140,7 @@ Syntax highlighting: 314 MathJax Support: 153 Rust code specific features: 148 For Developers: 788 -Alternate Backends: 710 +Alternative Backends: 710 Contributors: 85 ``` @@ -329,7 +329,7 @@ the usual `RUST_LOG` to control logging verbosity. ## Wrapping Up Although contrived, hopefully this example was enough to show how you'd create -an alternate backend for `mdbook`. If you feel it's missing something, don't +an alternative backend for `mdbook`. If you feel it's missing something, don't hesitate to create an issue in the [issue tracker] so we can improve the user guide. diff --git a/src/config.rs b/src/config.rs index 3e6b7a89..02a66421 100644 --- a/src/config.rs +++ b/src/config.rs @@ -3,7 +3,7 @@ //! The main entrypoint of the `config` module is the `Config` struct. This acts //! essentially as a bag of configuration information, with a couple //! pre-determined tables (`BookConfig` and `BuildConfig`) as well as support -//! for arbitrary data which is exposed to plugins and alternate backends. +//! for arbitrary data which is exposed to plugins and alternative backends. //! //! //! # Examples diff --git a/tests/alternate_backends.rs b/tests/alternative_backends.rs similarity index 97% rename from tests/alternate_backends.rs rename to tests/alternative_backends.rs index 41cf2f84..a8593889 100644 --- a/tests/alternate_backends.rs +++ b/tests/alternative_backends.rs @@ -1,4 +1,4 @@ -//! Integration tests to make sure alternate backends work. +//! Integration tests to make sure alternative backends work. extern crate mdbook; extern crate tempfile;