Skip to content

Conversation

@arthenice
Copy link
Contributor

@arthenice arthenice commented Feb 9, 2025

The Javadoc contained invalid syntax for links.
Some code elements were not closed leading to text not appearing in the help.

Some examples of errors in the current documentation:

image

image

Following this checklist to help us incorporate your contribution quickly and easily:

  • Make sure there is a GitHub issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a GitHub issue. Your pull request should address just this issue, without pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [#XXX] - Fixes bug in SessionManager,
    where you replace #XXX with the appropriate GitHub issue. Best practice
    is to use the GitHub issue title in the pull request title and in the first line of the commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • add fixes #XXX if merging the PR should close a related issue.
  • Run mvn verify to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.
  • If you have a group of commits related to the same change, please squash your commits into one and force push your branch using git rebase -i.
  • Committers: Make sure a milestone is set on the PR

Trivial changes like typos do not require a GitHub issue (javadoc, comments...).
In this case, just format the pull request title like [DOC] - Add javadoc in SessionManager.

If this is your first contribution, you have to read the Contribution Guidelines

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement
if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

The Javadoc contained invalid syntax for links.
Some code elements were not closed.

Signed-off-by: arthenice <[email protected]>
@fpapon fpapon self-requested a review February 10, 2025 05:56
Copy link
Member

@fpapon fpapon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@arthenice thanks for your contribution!

@lprimak lprimak added this to the 2.0.3 milestone Feb 10, 2025
@lprimak lprimak self-requested a review February 10, 2025 18:29
@lprimak
Copy link
Contributor

lprimak commented Feb 10, 2025

Thank you for your contribution. The Shiro team appreciate it.

@lprimak lprimak merged commit cb722c0 into apache:main Feb 10, 2025
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants