From a0635ee8dfd718b66c9dda19b71456ee4a456c1a Mon Sep 17 00:00:00 2001
From: orhun <orhunparmaksiz@gmail.com>
Date: Tue, 28 Sep 2021 22:50:19 +0300
Subject: [PATCH] docs(readme): move the explanation of sort flag to README.md

---
 README.md             | 12 ++++++++++++
 git-cliff/src/args.rs | 10 +---------
 2 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index d7b38d86c5..621a9bad59 100644
--- a/README.md
+++ b/README.md
@@ -131,6 +131,7 @@ git-cliff [FLAGS] [OPTIONS] [RANGE]
 -t, --tag <TAG>            Sets the tag for the latest version [env: TAG=]
 -b, --body <TEMPLATE>      Sets the template for the changelog body [env: TEMPLATE=]
 -s, --strip <PART>         Strips the given parts from the changelog [possible values: header, footer, all]
+    --sort <sort>          Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest]
 ```
 
 **Args:**
@@ -185,6 +186,17 @@ Generate a changelog scoped to a specific directory (useful for monorepos):
 git cliff --commit-path project1/
 ```
 
+Sort the commits inside sections:
+
+```sh
+# The oldest commit will be on top.
+# (default)
+git cliff --sort oldest
+
+# The newest commit will be on top.
+git cliff --sort newest
+```
+
 Save the changelog file to the specified file:
 
 ```sh
diff --git a/git-cliff/src/args.rs b/git-cliff/src/args.rs
index 827ae36837..62c00704ab 100644
--- a/git-cliff/src/args.rs
+++ b/git-cliff/src/args.rs
@@ -78,15 +78,7 @@ pub struct Opt {
 	#[structopt(value_name = "RANGE")]
 	pub range:       Option<String>,
 
-	/// Sets sorting of the commits inside the sections
-	///
-	/// If sort is `oldest`, the oldest commit will be on top. {n}
-	/// - PR #1 {n}
-	/// - PR #2
-	///
-	/// If sort is `newest`, the newest commit will be on top. {n}
-	/// - PR #2 {n}
-	/// - PR #1 {n}
+	/// Sets sorting of the commits inside sections.
 	#[structopt(
 		long,
 		possible_values = &["oldest", "newest"],