Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos/mistakes/wording/links in documentation/comments #1152

Merged
merged 3 commits into from
Jul 17, 2024

Conversation

Hannes-Kunnen
Copy link
Contributor

This fixes some typos/mistakes I found in the documentation and code comments. It also changes some wording to try and make their meaning more clear. Lastly it also fixes broken links and removes non-existent links.

I'm not entirely sure about the links. I fixed some broken links, I removed some that had no clear use case (links in table of content with no (sub-)title that matched it), I changed some links that were pointing to non-existent FAQs and pointed them to a similar FAQ. This might need special attention while reviewing.

Copy link

codecov bot commented Jul 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.61%. Comparing base (0a15b4d) to head (493c4b5).
Report is 88 commits behind head on develop/v2.

Additional details and impacted files
@@              Coverage Diff               @@
##           develop/v2    #1152      +/-   ##
==============================================
+ Coverage       72.00%   75.61%   +3.61%     
==============================================
  Files              93       96       +3     
  Lines           13795    12008    -1787     
==============================================
- Hits             9933     9080     -853     
+ Misses           3044     2109     -935     
- Partials          818      819       +1     

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

Changes-v2.md Outdated Show resolved Hide resolved
docs/00-anatomy.md Outdated Show resolved Hide resolved
docs/01-jwt.md Outdated Show resolved Hide resolved
docs/01-jwt.md Outdated Show resolved Hide resolved
docs/01-jwt.md Outdated Show resolved Hide resolved
jws/options.yaml Outdated Show resolved Hide resolved
jws/signer.go Outdated Show resolved Hide resolved
jwt/jwt_test.go Outdated Show resolved Hide resolved
jwt/jwt_test.go Outdated Show resolved Hide resolved
tools/cmd/genjwk/main.go Outdated Show resolved Hide resolved
@lestrrat
Copy link
Collaborator

lestrrat commented Jul 16, 2024

Thank you for taking the time to do this. There were certainly more typos than I had hoped for.

One request for future PRs, though: Please make them shorter, and make them against a single topic. For example a single PR on suboption vs sub-option would have been nicer than having to review all 72 files.

@Hannes-Kunnen
Copy link
Contributor Author

One request for future PRs, though: Please make them shorter, and make them against a single topic. For example a single PR on suboption vs sub-option would have been nicer than having to review all 72 files.

I'm sorry, I kind of dumped everything in this branch whenever I encountered something (and eventually I just went through most of the files I had opened and noted things here). I must have seen the few places that used the sub-option and went with that, I probably should have seen that sub-option was rarely used in comparison (personal bias could also have played a factor).

Change pre-existing use of "sub-option" to "suboption".
@lestrrat
Copy link
Collaborator

thanks!

@lestrrat lestrrat merged commit ce127d8 into lestrrat-go:develop/v2 Jul 17, 2024
22 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.

2 participants