fix(docs): fix linting issues - trailing spaces and EOF newline by ossdhaval · Pull Request #12849 · JanssenProject/jans (original) (raw)
📝 Walkthrough
Walkthrough
Widespread editorial updates across docs: remove "in the meantime" from contribution lines, normalize trailing newlines/whitespace, fix Markdown table headers, and apply assorted minor wording, punctuation, and formatting adjustments (no behavioral/code changes).
Changes
| Cohort / File(s) | Summary |
|---|---|
| Contribution sentence rewrites docs/janssen-server/recipes/apps/wordpress.md, docs/janssen-server/recipes/custom-web-development/.../{appauth-android,appauth-ios,appauth-js,asp-net,django,flask,mod-auth-openidc,node,react-native,react,spring-boot}.md, docs/janssen-server/recipes/forgot-password/{email,sms}.md, docs/janssen-server/recipes/open-banking/{client-registration,fapi-authn-request,requirements}.md, docs/janssen-server/recipes/saas/{aws,docusign,google,jira,office365,salesforce,webex,zoom}.md, docs/janssen-server/recipes/saml/{federation,idp-init-authn,sso-sp}.md, docs/janssen-server/reference/javadocs.md | Remove the phrase "in the meantime" from "Want to contribute?" guidance sentences for consistency. |
| Trailing newline & whitespace normalization docs/janssen-server/recipes/custom-web-development/README.md, docs/janssen-server/recipes/forgot-password/README.md, docs/janssen-server/recipes/open-banking/README.md, docs/janssen-server/recipes/saml/README.md, docs/janssen-server/scim/README.md | Add or normalize EOF newlines and remove trailing whitespace/artifacts. |
| Markdown table header fixes docs/janssen-server/reference/json/feature-flags/janssenauthserver-feature-flags.md, docs/janssen-server/reference/json/properties/{fido2-properties,janssenauthserver-properties,scim-properties}.md | Correct table header formatting (pipe alignment, column count). |
| Database reference docs docs/janssen-server/reference/database/{README,mysql-ops,pgsql-ops,rdbms-erwin}.md | Formatting, capitalization fixes (e.g., PostgreSQL), minor prose refinements, and small contextual additions in connection instructions. |
| Miscellaneous formatting & content flow docs/janssen-server/recipes/custom-web-development/authn-with-apache-reverse-proxy.md, docs/janssen-server/recipes/saas/README.md, docs/janssen-server/reference/kubernetes/config-secret-keys.md, docs/janssen-server/reference/learning-reference.md, docs/janssen-server/reference/openapi.md, docs/janssen-server/scim/config.md, docs/janssen-server/to-be-placed/{add-custom-ldifs,google}.md | Various heading/spacing/punctuation fixes, paragraph reflow, accessibility/image caption change, and minor expansion of Google auth instructions. |
Estimated code review effort
🎯 2 (Simple) | ⏱️ ~10 minutes
- Changes are numerous but highly repetitive and low-risk (text edits, whitespace, markdown fixes).
- Files that may need slightly more attention:
docs/janssen-server/reference/database/README.mddocs/janssen-server/reference/database/pgsql-ops.mddocs/janssen-server/to-be-placed/google.mddocs/janssen-server/reference/learning-reference.md
Possibly related issues
- fix(docs): fix linting issues - trailing spaces and EOF newline #12730 — Addresses the same MD009/MD047 lint concerns (trailing whitespace and EOF newline fixes) reflected in this PR.
Possibly related PRs
- fix(docs): fix linting issues - trailing spaces and EOF newline #12835 — Overlapping edits removing "in the meantime" and normalizing whitespace across docs.
- fix(docs): fix linting issues - trailing spaces and EOF newline #12731 — Similar documentation whitespace and minor wording fixes across many files.
- fix(docs): fix linting issues - trailing spaces and EOF newline #12766 — Related editorial fixes to the same contribution lines and EOF/trailing-space issues.
Suggested reviewers
- manojs1978
- jgomer2001
- devrimyatar
Pre-merge checks and finishing touches
✅ Passed checks (3 passed)
| Check name | Status | Explanation |
|---|---|---|
| Title check | ✅ Passed | The PR title clearly and specifically describes the main change: fixing linting issues involving trailing spaces and EOF newlines across documentation files. |
| Description check | ✅ Passed | The PR description follows the required template structure with all major sections present, though most template fields remain unfilled with concrete details (target issue is placeholder, implementation details omitted, and checklist items unchecked). |
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. |
✨ Finishing touches 🧪 Generate unit tests (beta)
- Create PR with unit tests
- Post copyable unit tests in a comment
- Commit unit tests in branch
docs-remove-trailing-space-and-newline
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
❤️ Share
Comment @coderabbitai help to get the list of available commands and usage tips.