Navigation Menu

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

docs: use consistent code style in manual pages #11027

Closed
wants to merge 2 commits into from

Conversation

emanuele6
Copy link
Contributor

I was reading curl_unescape(3) and I noticed that there was an extra space after the open parenthesis in the SYNOPSIS; I removed the extra space.

I also ran a few grep -r commands to find and remove extra spaces after '(' in other files, and to find and replace uses of T* instead of T *.

And I also fixed some formatting inconsistencies: in curl_unescape(3), all function parameter were mentioned with bold text except length, that was mentioned as 'length'; and, in curl_easy_unescape(3), all parameters were mentioned in bold text except url that was italicised. Now they are all mentioned in bold.
Documentation is not very consistent in how function parameter are formatted: many pages italicise them, and others display them in bold text; but I think it makes sense to at least be consistent with formatting within the same page.

I was reading curl_unescape(3) and I noticed that there was an extra
space after the open parenthesis in the SYNOPSIS; I removed the extra
space.

I also ran a few  grep -r  commands to find and remove extra spaces
after '(' in other files, and to find and replace uses of `T*' instead
of `T *'. Some of the instances of `T*` where unnecessary casts that I
removed.

I also fixed a comment that was misaligned in CURLMOPT_SOCKETFUNCTION.3.

And I fixed some formatting inconsistencies: in curl_unescape(3), all
function parameter were mentioned with bold text except length, that was
mentioned as 'length'; and, in curl_easy_unescape(3), all parameters
were mentioned in bold text except url that was italicised. Now they are
all mentioned in bold.
Documentation is not very consistent in how function parameter are
formatted: many pages italicise them, and others display them in bold
text; but I think it makes sense to at least be consistent with
formatting within the same page.
docs/libcurl/curl_easy_unescape.3 Outdated Show resolved Hide resolved
docs/libcurl/curl_unescape.3 Outdated Show resolved Hide resolved
docs/libcurl/curl_unescape.3 Outdated Show resolved Hide resolved
Also reword the DESCRIPTION section to mention "input"/"string" argument
in bold.
@emanuele6
Copy link
Contributor Author

emanuele6 commented Apr 26, 2023

Done; I also renamed the "url" parameter in curl_escape(3) to "string" to match curl_easy_escape(3).

@bagder bagder closed this in 73b9d7e Apr 26, 2023
bagder pushed a commit that referenced this pull request Apr 26, 2023
Also reword the DESCRIPTION section to mention "input"/"string" argument
in bold.

Closes #11027
@bagder
Copy link
Member

bagder commented Apr 26, 2023

Thanks!

@emanuele6 emanuele6 deleted the fixdoccodestyle branch April 26, 2023 08:23
bch pushed a commit to bch/curl that referenced this pull request Jul 19, 2023
I was reading curl_unescape(3) and I noticed that there was an extra
space after the open parenthesis in the SYNOPSIS; I removed the extra
space.

I also ran a few  grep -r  commands to find and remove extra spaces
after '(' in other files, and to find and replace uses of `T*' instead
of `T *'. Some of the instances of `T*` where unnecessary casts that I
removed.

I also fixed a comment that was misaligned in CURLMOPT_SOCKETFUNCTION.3.

And I fixed some formatting inconsistencies: in curl_unescape(3), all
function parameter were mentioned with bold text except length, that was
mentioned as 'length'; and, in curl_easy_unescape(3), all parameters
were mentioned in bold text except url that was italicised. Now they are
all mentioned in bold.
Documentation is not very consistent in how function parameter are
formatted: many pages italicise them, and others display them in bold
text; but I think it makes sense to at least be consistent with
formatting within the same page.

Closes curl#11027
bch pushed a commit to bch/curl that referenced this pull request Jul 19, 2023
Also reword the DESCRIPTION section to mention "input"/"string" argument
in bold.

Closes curl#11027
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants