You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@shiro.apache.org by lp...@apache.org on 2026/02/08 20:50:04 UTC
(shiro) branch main updated: markdown-lint: set line length to 180 (#2523)
This is an automated email from the ASF dual-hosted git repository.
lprimak pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shiro.git
The following commit(s) were added to refs/heads/main by this push:
new fb55af209 markdown-lint: set line length to 180 (#2523)
fb55af209 is described below
commit fb55af2099932dc014fbe1d33697023d9411467e
Author: John Bampton <jb...@users.noreply.github.com>
AuthorDate: Mon Feb 9 06:49:58 2026 +1000
markdown-lint: set line length to 180 (#2523)
https://github.com/DavidAnson/markdownlint/blob/main/doc/md013.md
Cleaned up some Markdown files putting each sentence on its own line results in no changes in output
When you run this check it does suggest setting the line length to 80. Not sure how many use a terminal to code etc.
We could do more cleanups and reduce the line length even further.
Long lines are hard to read in my editor and having this check will stop future regressions of very long lines in markdown files
---
.github/linters/.markdown-lint.yml | 3 ++-
CONTRIBUTING.md | 4 +++-
README.md | 3 ++-
samples/spring-mvc/README.md | 3 ++-
samples/spring/README.md | 3 ++-
5 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml
index af14d3623..a75287a66 100644
--- a/.github/linters/.markdown-lint.yml
+++ b/.github/linters/.markdown-lint.yml
@@ -16,7 +16,8 @@
# under the License.
# MD013/line-length Line length
-MD013: false
+MD013:
+ line_length: 180
# MD014/commands-show-output Dollar signs used before commands without showing output
MD014: false
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7b86ec88f..1d0432c35 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -4,7 +4,9 @@ Contributing to Apache Shiro
Summary
-------
-This document covers how to contribute to the Apache Shiro project. These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one. Your proposed code changes will be published to your own fork of the Apache Shiro project and you will submit a Pull Request for your changes to be added.
+This document covers how to contribute to the Apache Shiro project.
+These instructions assume you have a GitHub.com account, so if you don't have one you will have to create one.
+Your proposed code changes will be published to your own fork of the Apache Shiro project and you will submit a Pull Request for your changes to be added.
_Let's get started!!!_
diff --git a/README.md b/README.md
index 504855557..8ef4a29c9 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,8 @@
Apache Shiro
============
-[Apache Shiro](https://shiro.apache.org) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management. With Shiro’s easy-to-understand API, you can quickly and easily secure any application – from the smallest mobile applications to the largest web and enterprise applications.
+[Apache Shiro](https://shiro.apache.org) is a powerful and easy-to-use Java security framework that performs authentication, authorization, cryptography, and session management.
+With Shiro’s easy-to-understand API, you can quickly and easily secure any application – from the smallest mobile applications to the largest web and enterprise applications.
Documentation and Examples
--------------------------
diff --git a/samples/spring-mvc/README.md b/samples/spring-mvc/README.md
index 1ad1b8592..e08a01f51 100644
--- a/samples/spring-mvc/README.md
+++ b/samples/spring-mvc/README.md
@@ -1,7 +1,8 @@
Apache Shiro + Spring Web Example
=================================
-This example creates a web application (WAR packaged) to demonstrate configuring Apache Shiro via Spring. This example also includes a Spring Remoting example.
+This example creates a web application (WAR packaged) to demonstrate configuring Apache Shiro via Spring.
+This example also includes a Spring Remoting example.
Run the Example
---------------
diff --git a/samples/spring/README.md b/samples/spring/README.md
index d70899c80..87396cb7c 100644
--- a/samples/spring/README.md
+++ b/samples/spring/README.md
@@ -1,7 +1,8 @@
Apache Shiro + Spring Web Example
=================================
-This example creates a web application (WAR packaged) to demonstrate configuring Apache Shiro via Spring. This example also includes a Spring Remoting example.
+This example creates a web application (WAR packaged) to demonstrate configuring Apache Shiro via Spring.
+This example also includes a Spring Remoting example.
Run the Example
---------------