jagrosh / jagrosh/Vortex

Have an example/explain what is considered a newline under https://github.com/jagrosh/Vortex/wiki/Auto-Moderation#-maximum-lines

Open
#124 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
599
Forks
338
PR merge metrics
No merged PRs in 30d

Description

It seems like a lot of people don't realize that a single line that wraps around a lot is not a new line, so it could be better to maybe have screenshot examples or explain it in more detail rather than just explain how >>maxlines works :^)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Vortex wiki's Auto-Moderation section at the linked “Maximum Lines” entry and review how maxlines is currently explained. Add a clear explanation or screenshot examples showing that visual wrapping is not a newline, so readers can distinguish wrapped text from separate lines.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.