Move errors reorganize datetime add contributing instructions merge master

AndyGauge · AndyGauge · commit 8df54e6c7cb9 · 2018-06-11T16:53:31.000-07:00
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -12,6 +12,8 @@ No worries if anything in these lists is unclear. Just submit the PR and ask awa
 - [ ] commits are squashed into one and rebased to latest master
 - [ ] PR contains correct "fixes #ISSUE_ID" clause to autoclose the issue on PR merge
     -  if issue does not exist consider creating it or remove the clause
+- [ ] spell check runs without errors `./ci/spellchecker.sh`
+- [ ] link check runs without errors `link-checker ./book`
 - [ ] non rendered items are in sorted order (links, reference, identifiers, Cargo.toml)
 - [ ] links to docs.rs have wildcard version `https://docs.rs/tar/*/tar/struct.Entry.html`
 - [ ] example has standard [error handling](https://rust-lang-nursery.github.io/rust-cookbook/about.html#a-note-about-error-handling)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,9 +44,61 @@ To run the cookbook test suite:
 cargo test
 ```
 
+## Linters
+
+The Rust Cookbook comes with link checking and spell checking linters that
+run on the continuous integration server.  These linters should be run locally
+before submitting a pull request to ensure there are no dead links or spelling
+errors made.
+
+To install the link checker, review the documentation for [python] to install
+python 3.6 and pip3.  Installing link-checker once the dependencies are met
+is done with pip3.
+
+```
+[sudo] pip3 install link-checker==0.1.0
+```
+
+Alternatively, set up the user install directory on your PATH variable and
+install link-checker for your user
+
+```
+pip3 install -user link-checker==0.1.0
+```
+
+Checking the links of the book locally first requires the book to be built
+with mdBook.  From the root directory of the cookbook, the following commands
+run the link checker.
+
+```
+mdbook build
+link-checker ./book
+```
+
+The aspell binary provides spell checking.  Apt packages provide installation
+on Debian based operating systems.
+
+```
+[sudo] apt install aspell -y
+```
+
+To check the spelling of the Rust Cookbook locally, run the following command
+from the root of the Cookbook.
+
+```
+./ci/spellchecker.sh
+```
+
+If the spell checker finds a misspelled word, you have the opportunity to
+correct the spelling mistake with the number keys.  If the spelling mistake
+is erroneous, add the word to the dictionary located in `ci/dictionary.txt`.
+Pressing `a` or `l` will not add the word to the custom dictionary.
+
 [mdbook]: http://azerupi.github.io/mdBook/index.html
+[python]: https://packaging.python.org/tutorials/installing-packages/#install-pip-setuptools-and-wheel
 [skeptic]: https://github.com/brson/rust-skeptic
 
+
 ## Finding what to contribute
 
 This project is intended to be simple to contribute to, and to always
diff --git a/ci/dictionary.txt b/ci/dictionary.txt
@@ -12,8 +12,11 @@ akshat
 alisha
 AlphaNumeric
 ApiResponse
+apis
+APIs
 Appender
 appender
+applicationx
 args
 ascii
 ashley
@@ -280,6 +283,7 @@ SystemRandom
 SystemTime
 SystemTimeError
 TcpListener
+tcpip
 TcpStream
 TempDir
 tempdir
@@ -297,6 +301,7 @@ tuple
 Tuple
 typesafe
 unary
+unix
 unwinded
 UpperHex
 uptime
@@ -310,6 +315,7 @@ usize
 VarError
 versa
 Versioning
+versioning
 VersionReq
 vreq
 WalkDir
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -9,33 +9,35 @@
 - [Compression](compression.md)
   - [Working with Tarballs](compression/tar.md)
 - [Concurrency](concurrency.md)
-  - [Threads](concurrency/threads.md)
-  - [Parallel Tasks](concurrency/parallel.md)
+  - [Explicit Threads](concurrency/threads.md)
+  - [Data Parallelism](concurrency/parallel.md)
 - [Cryptography](cryptography.md)
   - [Hashing](cryptography/hashing.md)
   - [Encryption](cryptography/encryption.md)
 - [Data Structures](data_structures.md)
-  - [Constants](data_structures/constant.md)
-  - [Custom](data_structures/custom.md)
+  - [Bitfield](data_structures/bitfield.md)
 - [Date and Time](datetime.md)
-  - [Duration](datetime/duration.md)
+  - [Duration and Calculation](datetime/duration.md)
   - [Parsing and Displaying](datetime/parse.md)
 - [Development Tools](development_tools.md)
   - [Debugging](development_tools/debugging.md)
     - [Log Messages](development_tools/debugging/log.md)
     - [Configure Logging](development_tools/debugging/config_log.md)
   - [Versioning](development_tools/versioning.md)
-  - [Error Handling](development_tools/errors.md)
   - [Build Time Tooling](development_tools/build_tools.md)
 - [Encoding](encoding.md)
   - [Strings](encoding/strings.md)
   - [CSV processing](encoding/csv.md)
   - [Complex Data Types](encoding/complex.md)
+- [Error Handling](errors.md)
+  - [Handle Error Variants](errors/handle.md)
 - [File System](file.md)
   - [Read & Write](file/read-write.md)
   - [Directory Traversal](file/dir.md)
 - [Hardware Support](hardware.md)
   - [Processor](hardware/processor.md)
+- [Memory Management](mem.md)
+  - [Global Static](mem/global_static.md)
 - [Network](net.md)
   - [Server](net/server.md)
 - [Operating System](os.md)
diff --git a/src/data_structures.md b/src/data_structures.md
@@ -2,11 +2,8 @@
 
 | Recipe | Crates | Categories |
 |--------|--------|------------|
-| [Declare lazily evaluated constant][ex-lazy-constant] | [![lazy_static-badge]][lazy_static] | [![cat-caching-badge]][cat-caching] [![cat-rust-patterns-badge]][cat-rust-patterns] |
 | [Define and operate on a type represented as a bitfield][ex-bitflags] | [![bitflags-badge]][bitflags] | [![cat-no-std-badge]][cat-no-std] |
 
-[ex-lazy-constant]: data_structures/constant.html#declare-lazily-evaluated-constant
-
-[ex-bitflags]: data_structures/custom.html#define-and-operate-on-a-type-represented-as-a-bitfield
+[ex-bitflags]: data_structures/bitfield.html#define-and-operate-on-a-type-represented-as-a-bitfield
 
 {{#include links.md}}
diff --git a/src/data_structures/bitfield.md b/src/data_structures/bitfield.md
@@ -1,5 +1,5 @@
 # Custom
 
-{{#include custom/bitfield.md}}
+{{#include bitfield/bitfield.md}}
 
 {{#include ../links.md}}
diff --git a/src/data_structures/bitfield/bitfield.md b/src/data_structures/bitfield/bitfield.md
diff --git a/src/data_structures/constant.md b/src/data_structures/constant.md
diff --git a/src/datetime.md b/src/datetime.md
@@ -4,16 +4,16 @@
 |--------|--------|------------|
 | [Measure elapsed time][ex-measure-elapsed-time] | [![std-badge]][std] | [![cat-time-badge]][cat-time] |
 | [Perform checked date and time calculations][ex-datetime-arithmetic] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
+| [Convert a local time to another timezone][ex-convert-datetime-timezone] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
 | [Examine the date and time][ex-examine-date-and-time] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
 | [Convert date to UNIX timestamp and vice versa][ex-convert-datetime-timestamp] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
-| [Convert a local time to an another UTC timezone and vice versa][ex-convert-datetime-timezone] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
 | [Display formatted date and time][ex-format-datetime] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
 | [Parse string into DateTime struct][ex-parse-datetime] | [![chrono-badge]][chrono] | [![cat-date-and-time-badge]][cat-date-and-time] |
 
 [ex-measure-elapsed-time]: datetime/duration.html#measure-the-elapsed-time-between-two-code-sections
 [ex-datetime-arithmetic]: datetime/duration.html#perform-checked-date-and-time-calculations
-[ex-examine-date-and-time]: datetime/duration.html#examine-the-date-and-time
-[ex-convert-datetime-timestamp]: datetime/parse.html#convert-date-to-unix-timestamp-and-vice-versa
+[ex-convert-datetime-timestamp]: datetime/duration.html#convert-a-local-time-to-another-timezone
+[ex-examine-date-and-time]: datetime/parse.html#examine-the-date-and-time
 [ex-convert-datetime-timezone]: datetime/parse.html#convert-a-local-time-to-an-another-utc-timezone-and-vice-versa
 [ex-format-datetime]: datetime/parse.html#display-formatted-date-and-time
 [ex-parse-datetime]: datetime/parse.html#parse-string-into-datetime-struct
diff --git a/src/datetime/duration.md b/src/datetime/duration.md
@@ -1,9 +1,9 @@
-# Duration
+# Duration and Calculation
 
 {{#include duration/profile.md}}
 
 {{#include duration/checked.md}}
 
-{{#include duration/current.md}}
+{{#include duration/timezone.md}}
 
 {{#include ../links.md}}
diff --git a/src/datetime/duration/timezone.md b/src/datetime/duration/timezone.md
@@ -1,4 +1,4 @@
-## Convert a local time to an another UTC timezone and vice versa
+## Convert a local time to another timezone
 
 [![chrono-badge]][chrono] [![cat-date-and-time-badge]][cat-date-and-time]
 
diff --git a/src/datetime/parse.md b/src/datetime/parse.md
@@ -1,8 +1,8 @@
 # Parsing and Displaying
 
-{{#include parse/timestamp.md}}
+{{#include parse/current.md}}
 
-{{#include parse/timezone.md}}
+{{#include parse/timestamp.md}}
 
 {{#include parse/format.md}}
 
diff --git a/src/datetime/parse/current.md b/src/datetime/parse/current.md
diff --git a/src/development_tools.md b/src/development_tools.md
@@ -12,14 +12,6 @@
 | [Find the latest version satisfying given range][ex-semver-latest] | [![semver-badge]][semver] | [![cat-config-badge]][cat-config] |
 | [Check external command version for compatibility][ex-semver-command] | [![semver-badge]][semver] | [![cat-text-processing-badge]][cat-text-processing] [![cat-os-badge]][cat-os]
 
-## Error Handling
-
-| Recipe | Crates | Categories |
-|--------|--------|------------|
-| [Handle errors correctly in main][ex-error-chain-simple-error-handling] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
-| [Avoid discarding errors during error conversions][ex-error-chain-avoid-discarding] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
-| [Obtain backtrace of complex error scenarios][ex-error-chain-backtrace] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
-
 ## Build Time
 
 | Recipe | Crates | Categories |
@@ -34,10 +26,6 @@
 [ex-semver-latest]: development_tools/versioning.html#find-the-latest-version-satisfying-given-range
 [ex-semver-command]: development_tools/versioning.html#check-external-command-version-for-compatibility
 
-[ex-error-chain-simple-error-handling]: development_tools/errors.html#handle-errors-correctly-in-main
-[ex-error-chain-avoid-discarding]: development_tools/errors.html#avoid-discarding-errors-during-error-conversions
-[ex-error-chain-backtrace]: development_tools/errors.html#obtain-backtrace-of-complex-error-scenarios
-
 [ex-cc-static-bundled]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library
 [ex-cc-static-bundled-cpp]: development_tools/build_tools.html#compile-and-link-statically-to-a-bundled-c-library-1
 [ex-cc-custom-defines]: development_tools/build_tools.html#compile-a-c-library-while-setting-custom-defines
diff --git a/src/development_tools/errors.md b/src/development_tools/errors.md
@@ -1,9 +1 @@
 # Error Handling
-
-{{#include errors/main.md}}
-
-{{#include errors/retain.md}}
-
-{{#include errors/backtrace.md}}
-
-{{#include ../links.md}}
diff --git a/src/errors.md b/src/errors.md
@@ -0,0 +1,13 @@
+# Error Handling
+
+| Recipe | Crates | Categories |
+|--------|--------|------------|
+| [Handle errors correctly in main][ex-error-chain-simple-error-handling] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
+| [Avoid discarding errors during error conversions][ex-error-chain-avoid-discarding] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
+| [Obtain backtrace of complex error scenarios][ex-error-chain-backtrace] | [![error-chain-badge]][error-chain] | [![cat-rust-patterns-badge]][cat-rust-patterns] |
+
+[ex-error-chain-simple-error-handling]: errors/handle.html#handle-errors-correctly-in-main
+[ex-error-chain-avoid-discarding]: errors/handle.html#avoid-discarding-errors-during-error-conversions
+[ex-error-chain-backtrace]: errors/handle.html#obtain-backtrace-of-complex-error-scenarios
+
+{{#include links.md}}
diff --git a/src/errors/handle.md b/src/errors/handle.md
@@ -0,0 +1,9 @@
+# Error Handling
+
+{{#include handle/main.md}}
+
+{{#include handle/retain.md}}
+
+{{#include handle/backtrace.md}}
+
+{{#include ../links.md}}
diff --git a/src/errors/handle/backtrace.md b/src/errors/handle/backtrace.md
diff --git a/src/errors/handle/main.md b/src/errors/handle/main.md
diff --git a/src/errors/handle/retain.md b/src/errors/handle/retain.md
diff --git a/src/intro.md b/src/intro.md
@@ -28,6 +28,8 @@ community. It needs and welcomes help. For details see
 
 {{#include data_structures.md}}
 
+{{#include datetime.md}}
+
 {{#include development_tools.md}}
 
 {{#include encoding.md}}
@@ -36,6 +38,8 @@ community. It needs and welcomes help. For details see
 
 {{#include hardware.md}}
 
+{{#include mem.md}}
+
 {{#include net.md}}
 
 {{#include os.md}}
diff --git a/src/mem.md b/src/mem.md
@@ -0,0 +1,9 @@
+# Memory Management
+
+| Recipe | Crates | Categories |
+|--------|--------|------------|
+| [Declare lazily evaluated constant][ex-lazy-constant] | [![lazy_static-badge]][lazy_static] | [![cat-caching-badge]][cat-caching] [![cat-rust-patterns-badge]][cat-rust-patterns] |
+
+[ex-lazy-constant]: mem/global_static.html#declare-lazily-evaluated-constant
+
+{{#include links.md}}
diff --git a/src/mem/global_static.md b/src/mem/global_static.md
@@ -0,0 +1,5 @@
+# Constants
+
+{{#include global_static/lazy-constant.md}}
+
+{{#include ../links.md}}
diff --git a/src/mem/global_static/lazy-constant.md b/src/mem/global_static/lazy-constant.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## Convert a local time to an another UTC timezone and vice versa`
	`1`	`+## Convert a local time to another timezone`
`2`	`2`
`3`	`3`	`[![chrono-badge]][chrono] [![cat-date-and-time-badge]][cat-date-and-time]`
`4`	`4`