Repository: clap-rs/clap
Pull request #3415 (2022-02-08 02:20:40)

fix(man): Rename crate to match style
I have access to the `clap-man` name but we use `clap_*`.  Rather than
people getting mixed up on which is supposed to use, we went with a
different name.

<!--
Thanks for helping out!

Please link the appropriate issue from your PR.

If you don't have an issue, we'd recommend starting with one first so the PR can focus on the
implementation (unless its an obvious bug or documentation fix that will have
little conversation).
-->



Patch:
diff --git a/Cargo.toml b/Cargo.toml
index cba86017..ec0f18f4 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,7 +5,7 @@ members = [
 	"clap_complete_fig",
 	"clap_generate",
 	"clap_generate_fig",
-	"clap_man",
+	"clap_mangen",
 ]
 
 [package]
diff --git a/clap_man/CHANGELOG.md b/clap_mangen/CHANGELOG.md
similarity index 100%
rename from clap_man/CHANGELOG.md
rename to clap_mangen/CHANGELOG.md
diff --git a/clap_man/CONTRIBUTING.md b/clap_mangen/CONTRIBUTING.md
similarity index 67%
rename from clap_man/CONTRIBUTING.md
rename to clap_mangen/CONTRIBUTING.md
index e54a51d0..18d1486c 100644
--- a/clap_man/CONTRIBUTING.md
+++ b/clap_mangen/CONTRIBUTING.md
@@ -1,3 +1,3 @@
 # How to Contribute
 
-See the [clap-wide CONTRIBUTING.md](../CONTRIBUTING.md). This will contain `clap_man` specific notes.
+See the [clap-wide CONTRIBUTING.md](../CONTRIBUTING.md). This will contain `clap_mangen` specific notes.
diff --git a/clap_man/Cargo.toml b/clap_mangen/Cargo.toml
similarity index 95%
rename from clap_man/Cargo.toml
rename to clap_mangen/Cargo.toml
index 9829c412..b0458c09 100644
--- a/clap_man/Cargo.toml
+++ b/clap_mangen/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "clap_man"
+name = "clap_mangen"
 version = "0.1.0"
 edition = "2018"
 include = [
@@ -9,8 +9,8 @@ include = [
 	"README.md"
 ]
 description = "A manpage generator for clap"
-repository = "https://github.com/clap-rs/clap/tree/master/clap_man"
-documentation = "https://docs.rs/clap_man"
+repository = "https://github.com/clap-rs/clap/tree/master/clap_mangen"
+documentation = "https://docs.rs/clap_mangen"
 keywords = [
 	"clap",
 	"cli",
diff --git a/clap_man/LICENSE-APACHE b/clap_mangen/LICENSE-APACHE
similarity index 100%
rename from clap_man/LICENSE-APACHE
rename to clap_mangen/LICENSE-APACHE
diff --git a/clap_man/LICENSE-MIT b/clap_mangen/LICENSE-MIT
similarity index 100%
rename from clap_man/LICENSE-MIT
rename to clap_mangen/LICENSE-MIT
diff --git a/clap_man/README.md b/clap_mangen/README.md
similarity index 70%
rename from clap_man/README.md
rename to clap_mangen/README.md
index 25e73110..77aae6c1 100644
--- a/clap_man/README.md
+++ b/clap_mangen/README.md
@@ -1,17 +1,17 @@
 <!-- omit in TOC -->
-# clap_man
+# clap_mangen
 
 > **Manpage generation for `clap`**
 
-[![Crates.io](https://img.shields.io/crates/v/clap_man?style=flat-square)](https://crates.io/crates/clap_man)
-[![Crates.io](https://img.shields.io/crates/d/clap_man?style=flat-square)](https://crates.io/crates/clap_man)
+[![Crates.io](https://img.shields.io/crates/v/clap_mangen?style=flat-square)](https://crates.io/crates/clap_mangen)
+[![Crates.io](https://img.shields.io/crates/d/clap_mangen?style=flat-square)](https://crates.io/crates/clap_mangen)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-APACHE)
 [![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://github.com/clap-rs/clap/blob/master/LICENSE-MIT)
 
 Dual-licensed under [Apache 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT).
 
 1. [About](#about)
-2. [API Reference](https://docs.rs/clap_man)
+2. [API Reference](https://docs.rs/clap_mangen)
 3. [Questions & Discussions](https://github.com/clap-rs/clap/discussions)
 4. [CONTRIBUTING](https://github.com/clap-rs/clap/blob/v3.0.0-rc.4/clap_generate/CCONTRIBUTING.md)
 5. [Sponsors](https://github.com/clap-rs/clap/blob/v3.0.0-rc.4/README.md#sponsors)
diff --git a/clap_man/examples/man.rs b/clap_mangen/examples/man.rs
similarity index 98%
rename from clap_man/examples/man.rs
rename to clap_mangen/examples/man.rs
index 6d8a2a23..96d267f8 100644
--- a/clap_man/examples/man.rs
+++ b/clap_mangen/examples/man.rs
@@ -1,5 +1,5 @@
 use clap::{arg, App};
-use clap_man::Man;
+use clap_mangen::Man;
 use std::io;
 
 // Run this example as `cargo run --example man | man -l -`.


Test patch:
diff --git a/clap_man/src/lib.rs b/clap_mangen/src/lib.rs
similarity index 100%
rename from clap_man/src/lib.rs
rename to clap_mangen/src/lib.rs
diff --git a/clap_man/src/render.rs b/clap_mangen/src/render.rs
similarity index 100%
rename from clap_man/src/render.rs
rename to clap_mangen/src/render.rs
diff --git a/clap_man/tests/generate.rs b/clap_mangen/tests/generate.rs
similarity index 97%
rename from clap_man/tests/generate.rs
rename to clap_mangen/tests/generate.rs
index aa98192b..65b690c0 100644
--- a/clap_man/tests/generate.rs
+++ b/clap_mangen/tests/generate.rs
@@ -1,5 +1,5 @@
 use clap::{arg, App};
-use clap_man::Man;
+use clap_mangen::Man;
 use std::io;
 
 #[test]