Skip to content

docs: fix typos, syntax, formating#1851

Merged
kingthorin merged 2 commits into
datafaker-net:mainfrom
kingthorin:site-typos
Jun 23, 2026
Merged

docs: fix typos, syntax, formating#1851
kingthorin merged 2 commits into
datafaker-net:mainfrom
kingthorin:site-typos

Conversation

@kingthorin

@kingthorin kingthorin commented Jun 22, 2026

Copy link
Copy Markdown
Collaborator

All tested locally with mkdocs server.

Note for the four language files that were modified that was to address:

INFO    -  DeprecationWarning: "\s" is an invalid escape sequence. Such sequences will not work in the future.
             File ".....datafaker/.venv/lib/python3.14/site-packages/jinja2/lexer.py", line 391, in __next__
               self.current = next(self._iter)
             File ".....datafaker/.venv/lib/python3.14/site-packages/jinja2/lexer.py", line 654, in wrap
               .decode("unicode-escape")
Patched 4 language files — \s → \\s, \- → \\-:

material/partials/languages/en.html
material/partials/languages/el.html
material/partials/languages/ja.html
material/partials/languages/zh-TW.html
mkdocs build clean now — no \s DeprecationWarning. Browser still get [\s\-]+ for search regex.

@codecov-commenter

codecov-commenter commented Jun 22, 2026

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.36%. Comparing base (5f4ed38) to head (1cfab47).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #1851      +/-   ##
============================================
- Coverage     92.45%   92.36%   -0.09%     
+ Complexity     3517     3515       -2     
============================================
  Files           344      344              
  Lines          6968     6968              
  Branches        684      684              
============================================
- Hits           6442     6436       -6     
- Misses          363      367       +4     
- Partials        163      165       +2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread docs/documentation/contributing.md Outdated
- Try and make one logical change per PR. That is not make many changes in one PR. Submit multiple PRs instead.
- Starting with Datafaker 2.x, Java 17 is our target version. If you need anything older than that, we recommend using the 1.x versions of Datafaker instead. Note that while the 1.x is stable and free of known bugs, this branch won't receive future updates.
- Starting with Datafaker 2.x, Java 17 is our target version. If you need anything older than that, we recommend using the 1.x versions of Datafaker instead.
> **Note**: that while the 1.x is stable and free of known bugs, this branch won't receive future updates.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

i wouldn't say it is free of known bugs...
there is already a ton of known bugs fixed in 2.x and not backported to 1.x

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

That wasn't rewritten it was just shifted onto a new line, but yeah I get your point and will tweak the text.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Fixed

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

thanks, feel free to merge
lgtm from my side

Signed-off-by: kingthorin <kingthorin@users.noreply.github.com>
Signed-off-by: kingthorin <kingthorin@users.noreply.github.com>
@kingthorin kingthorin merged commit 5f39c3a into datafaker-net:main Jun 23, 2026
17 checks passed
@asolntsev asolntsev added the documentation Improvements or additions to documentation label Jun 23, 2026
@asolntsev asolntsev added this to the 3.0.0 milestone Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants