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

Doc cleanup #446

Merged
merged 22 commits into from
Dec 2, 2023
Merged

Doc cleanup #446

merged 22 commits into from
Dec 2, 2023

Conversation

jetmore
Copy link
Contributor

@jetmore jetmore commented Nov 13, 2023

Not sure why I got a wild hair about this, but here we are. Prime for a squash merge, but I thought leaving the fine-toothed commits might make reviewing easier. Thanks for continuing to maintain Net::SSLeay

jetmore and others added 22 commits November 11, 2023 13:04
…re a few actual changes in the sample code

- added a comment to raw text in code
- added missing sigils
- added missing semicolons
- removed a couple of instances of double '=' in an assignment
- remove trailing whitespace
- use consistent brace style
- space after # in comments
Examples in the indented code snipped should be commented
When, for L<text|schema>, text and schema are identical, you don't need both of them
a few links that were almost but not quite identical
Old links to https://www.openssl.org/docs/ssl/* and https://www.openssl.org/docs/crypto/* redirect on the openssl side to https://www.openssl.org/docs/manmaster/man3/*.  Since there were already some links to https://www.openssl.org/docs/manmaster/man3/* in the docs, make them all link to it
- in compatility lines, standardize on `OpenSSL VERSION`, over `openssl-VERSION`
- fix ending prose with semicolons
- add links in security section to a list, the BEAST attack links were rendered all on one line
- indent a couple of missed code sections
- small formatting and readbility changes
@h-vn h-vn merged commit f7aa524 into radiator-software:master Dec 2, 2023
29 of 100 checks passed
@h-vn h-vn added doc Changes to documentation tech-debt Technical debt labels Dec 2, 2023
@h-vn
Copy link
Contributor

h-vn commented Dec 2, 2023

Thanks for all the work you did.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Changes to documentation tech-debt Technical debt
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants