docs: stop using the word 'just' by bagder · Pull Request #20793 · curl/curl

bagder · 2026-03-02T22:43:55Z

It is almost never a good word and almost always a filler that should be avoided.

Copilot

Pull request overview

This PR standardizes documentation tone by removing the filler word “just” across docs/manpages/examples, and enforces this via the bad-words checker list.

Changes:

Rephrases many documentation sentences to avoid “just” (plus some line-wrapping adjustments).
Updates example source comments similarly.
Adds \bjust\b to .github/scripts/badwords.txt to prevent reintroduction.

Reviewed changes

Copilot reviewed 128 out of 128 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tests/unit/README.md	Rephrases unit-test build instructions to remove “just”.
docs/wcurl.md	Rephrases usage text and `--dry-run` description.
docs/tests/TEST-SUITE.md	Rephrases debugger/testdata descriptions to remove “just”.
docs/tests/HTTP.md	Rephrases pytest guidance to remove “just”.
docs/tests/FILEFORMAT.md	Rephrases variable/server/command descriptions to remove “just”.
docs/tests/CI.md	Rephrases contributor guidance and CI rerun advice.
docs/mk-ca-bundle.md	Rephrases OpenSSL/GnuTLS applicability sentence.
docs/libcurl/opts/CURLOPT_UPLOAD_BUFFERSIZE.md	Rephrases request-vs-order wording.
docs/libcurl/opts/CURLOPT_SSL_VERIFYPEER.md	Rephrases security warning text.
docs/libcurl/opts/CURLOPT_SSL_VERIFYHOST.md	Rephrases security warning text.
docs/libcurl/opts/CURLOPT_SSL_CTX_FUNCTION.md	Rephrases callback timing description.
docs/libcurl/opts/CURLOPT_SSH_PUBLIC_KEYFILE.md	Rephrases default filename behavior text.
docs/libcurl/opts/CURLOPT_RTSP_REQUEST.md	Rephrases protocol comparison phrasing.
docs/libcurl/opts/CURLOPT_RESOLVE.md	Rephrases timeout behavior comparison.
docs/libcurl/opts/CURLOPT_PROXY_SSL_VERIFYPEER.md	Rephrases security warning text.
docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.md	Rephrases Windows-specific instruction comment.
docs/libcurl/opts/CURLOPT_PORT.md	Rephrases typical port selection text.
docs/libcurl/opts/CURLOPT_PINNEDPUBLICKEY.md	Rephrases Windows-specific instruction comment.
docs/libcurl/opts/CURLOPT_NOBODY.md	Rephrases HEAD/body-transfer explanation.
docs/libcurl/opts/CURLOPT_HTTP_VERSION.md	Rephrases request-vs-order explanation.
docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.md	Rephrases proxy pass-through text.
docs/libcurl/opts/CURLOPT_HEADERFUNCTION.md	Rephrases header-callback explanation.
docs/libcurl/opts/CURLOPT_FTPPORT.md	Rephrases parameter description and wrapping.
docs/libcurl/opts/CURLOPT_FOLLOWLOCATION.md	Rephrases redirects discussion and historical note.
docs/libcurl/opts/CURLOPT_ERRORBUFFER.md	Rephrases error-buffer benefit explanation.
docs/libcurl/opts/CURLOPT_DOH_SSL_VERIFYPEER.md	Rephrases security warning text.
docs/libcurl/opts/CURLOPT_COOKIELIST.md	Rephrases cookie format description.
docs/libcurl/opts/CURLOPT_COOKIEFILE.md	Rephrases cookie format and stdin wording.
docs/libcurl/opts/CURLOPT_BUFFERSIZE.md	Rephrases request-vs-order and multi-buffer explanation.
docs/libcurl/opts/CURLOPT_AWS_SIGV4.md	Rephrases example string behavior explanation.
docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.md	Rephrases request header guidance.
docs/libcurl/opts/CURLMOPT_PUSHFUNCTION.md	Rephrases PUSH_PROMISE header access description.
docs/libcurl/opts/CURLINFO_TLS_SSL_PTR.md	Rephrases OpenSSL fork reporting sentence.
docs/libcurl/opts/CURLINFO_PRETRANSFER_TIME_T.md	Rephrases timing description.
docs/libcurl/opts/CURLINFO_PRETRANSFER_TIME.md	Rephrases timing description.
docs/libcurl/libcurl.md	Rephrases global init/cleanup guidance.
docs/libcurl/libcurl.m4	Attempts to rephrase “just” but alters macro header region.
docs/libcurl/libcurl-url.md	Rephrases handle duplication sentence.
docs/libcurl/libcurl-tutorial.md	Rephrases tutorial prose and line wrapping.
docs/libcurl/libcurl-security.md	Rephrases security guidance prose and wrapping.
docs/libcurl/libcurl-multi.md	Rephrases multi API description and wrapping.
docs/libcurl/libcurl-errors.md	Rephrases error-buffer recommendation prose.
docs/libcurl/curl_version_info.md	Rephrases version string description.
docs/libcurl/curl_url_get.md	Rephrases returned-string description.
docs/libcurl/curl_multi_waitfds.md	Rephrases “size==0” guidance.
docs/libcurl/curl_multi_timeout.md	Rephrases “-1 timeout” meaning.
docs/libcurl/curl_multi_socket_all.md	Rephrases “single one” phrasing.
docs/libcurl/curl_multi_remove_handle.md	Rephrases callback restriction sentence.
docs/libcurl/curl_multi_perform.md	Rephrases “called just in case” sentence.
docs/libcurl/curl_multi_info_read.md	Rephrases description and completion sentence.
docs/libcurl/curl_multi_assign.md	Removes a rationale paragraph that contained “just”.
docs/libcurl/curl_mprintf.md	Rephrases precision explanation (introduces a typo).
docs/libcurl/curl_global_trace.md	Rephrases thread-safety caveat (meaning changes).
docs/libcurl/curl_global_sslset.md	Rephrases thread-safety caveat and OpenSSL naming sentence.
docs/libcurl/curl_global_init.md	Rephrases thread-safety caveat.
docs/libcurl/curl_global_cleanup.md	Rephrases thread-safety caveat.
docs/libcurl/curl_easy_ssls_export.md	Rephrases “grep” sentence.
docs/libcurl/curl_easy_setopt.md	Rephrases PREQUOTE description.
docs/libcurl/curl_easy_reset.md	Rephrases “just created” sentence.
docs/libcurl/curl_easy_getinfo.md	Rephrases timing descriptions and wrapping.
docs/libcurl/curl_easy_escape.md	Rephrases URL encoding caution sentence.
docs/libcurl/ABI.md	Rephrases ABI upgrade behavior sentence.
docs/internals/TLS-SESSIONS.md	Rephrases key derivation / privacy section.
docs/internals/STRPARSE.md	Rephrases leading-zero wording; leaves a grammar issue nearby.
docs/internals/SCORECARD.md	Rephrases “interested in” sentence.
docs/internals/NEW-PROTOCOL.md	Rephrases protocol guidance and test infra statement.
docs/internals/MULTI-EV.md	Rephrases socket identifier reuse sentence.
docs/internals/LLIST.md	Rephrases cleanup sentence.
docs/internals/CONNECTION-FILTERS.md	Rephrases conceptual explanations; minor line tightening.
docs/internals/CODE_STYLE.md	Rephrases style guidance sentences.
docs/internals/CLIENT-WRITERS.md	Rephrases insertion guidance sentence.
docs/internals/CHECKSRC.md	Rephrases LONGLINE ignore guidance.
docs/examples/usercertinmem.c	Rephrases comment about SSL context timing.
docs/examples/smtp-tls.c	Rephrases payload comment text.
docs/examples/smtp-ssl.c	Rephrases payload comment text.
docs/examples/smtp-multi.c	Rephrases payload comment text.
docs/examples/smtp-mail.c	Rephrases payload comment text.
docs/examples/smtp-authzid.c	Rephrases payload comment text.
docs/examples/pop3-uidl.c	Rephrases server URL comment.
docs/examples/pop3-top.c	Rephrases server URL comment.
docs/examples/pop3-stat.c	Rephrases server URL comment.
docs/examples/pop3-noop.c	Rephrases server URL comment.
docs/examples/imap-noop.c	Rephrases server URL comment.
docs/examples/imap-lsub.c	Rephrases server URL comment.
docs/examples/imap-examine.c	Rephrases server URL comment.
docs/examples/imap-delete.c	Rephrases server URL comment.
docs/examples/imap-create.c	Rephrases server URL comment.
docs/examples/imap-append.c	Rephrases callback comment text.
docs/examples/httpput.c	Rephrases “example” comment text and wraps lines.
docs/examples/http-post.c	Rephrases URL comment text.
docs/examples/hiperfifo.c	Rephrases timer comment text.
docs/examples/headerapi.c	Rephrases content-ignore comment text.
docs/examples/ghiper.c	Rephrases timer comment text.
docs/examples/ftpupload.c	Rephrases description comment.
docs/examples/cacertinmem.c	Rephrases comment about SSL context timing.
docs/examples/adddocsref.pl	Rephrases comment line (keeps a spelling issue).
docs/examples/README.md	Rephrases build instruction sentence.
docs/cmdline-opts/write-out.md	Rephrases formatting guidance and timing var description.
docs/cmdline-opts/skip-existing.md	Rephrases file presence explanation.
docs/cmdline-opts/quote.md	Rephrases timing wording (“immediately”).
docs/cmdline-opts/output.md	Rephrases ordering requirement sentence.
docs/cmdline-opts/list-only.md	Rephrases “information than filenames” sentence.
docs/cmdline-opts/hsts.md	Rephrases in-memory HSTS sentence.
docs/cmdline-opts/form.md	Rephrases @/< explanation.
docs/cmdline-opts/data-urlencode.md	Rephrases “be careful” sentence.
docs/cmdline-opts/data-ascii.md	Rephrases alias sentence.
docs/cmdline-opts/alt-svc.md	Rephrases in-memory cache sentence.
docs/VULN-DISCLOSURE-POLICY.md	Rephrases memory usage and incident declaration text.
docs/TheArtOfHttpScripting.md	Rephrases tutorial prose in several sections.
docs/TODO.md	Rephrases TODO prose to remove “just”.
docs/SECURITY-ADVISORY.md	Rephrases “easy way” sentence.
docs/MANUAL.md	Rephrases FTPS, PASV/netrc, and output guidance sentences.
docs/MAIL-ETIQUETTE.md	Rephrases etiquette guidance sentences.
docs/KNOWN_RISKS.md	Rephrases URL-vetting warning sentence.
docs/IPFS.md	Rephrases gateway rewriting sentence.
docs/INSTALL-CMAKE.md	Rephrases “CMake usage” intro (now less accurate/less aligned).
docs/HTTP3.md	Rephrases development, eyeballing, and local test guidance.
docs/HTTP-COOKIES.md	Rephrases cookie-engine activation sentence.
docs/HISTORY.md	Rephrases historical prose (“only needed”).
docs/GOVERNANCE.md	Rephrases legal entity/team duty sentences.
docs/FAQ.md	Rephrases multiple answers and wraps lines.
docs/ECH.md	Rephrases discussion; removes a “Debugging” note block.
docs/EARLY-RELEASE.md	Rephrases patch-release wording.
docs/CURLDOWN.md	Rephrases quoting/formatting guidance.
docs/CONTRIBUTE.md	Rephrases contribution guidance sentences.
docs/BUGS.md	Rephrases troubleshooting guidance sentences.
SECURITY.md	Rephrases vulnerability reporting sentence.
.github/scripts/badwords.txt	Adds `just` to the bad-words list.

Comments suppressed due to low confidence (3)

docs/libcurl/curl_mprintf.md:163

Typo/duplication: "given as as a single" should be "given as a single".
docs/examples/adddocsref.pl:40
Spelling: "preciously" in this comment reads like a typo for "previously" (as in previously added refs).
docs/internals/STRPARSE.md:186
Grammar typo: "Does not handled 0x prefix" should be "Does not handle 0x prefix" (or similar).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/INSTALL-CMAKE.md

docs/libcurl/libcurl.m4

docs/libcurl/curl_global_trace.md

bagder · 2026-03-02T23:26:23Z

augment review

augmentcode · 2026-03-02T23:29:33Z

🤖 Augment PR Summary

Summary: Removes filler word “just” from curl’s docs and source comments, and adds it to the bad-words linter list.

Changes:

Add \bjust\b to .github/scripts/badwords.txt to discourage future usage
Revise a wide range of documentation pages and libcurl manpage sources to remove “just” while keeping intent
Update wording in option/manpage docs around redirects, callbacks, timing, and threading requirements
Refresh comments across libcurl/tool sources for clearer phrasing (no behavior changes intended)
Remove a few informal “note to self” style snippets in docs where applicable

Technical Notes: Text-only changes; no code logic modifications expected.
The bulk of edits are line-wrap adjustments after wording changes.
This aims to make the documentation more direct and consistent with project writing guidance.

_{🤖 Was this summary useful? React with 👍 or 👎}

augmentcode

Review completed. 2 suggestions posted.

Comment augment review to trigger a new review at any time.

docs/EARLY-RELEASE.md

docs/libcurl/curl_mprintf.md

Copilot

Pull request overview

Copilot reviewed 213 out of 213 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (2)

docs/examples/adddocsref.pl:40

Typo in the comment: "preciously" should likely be "previously" (as in previously-added refs).
docs/libcurl/curl_multi_assign.md:44
This edit drops an explanatory paragraph in the DESCRIPTION section. If the goal of the PR is only to remove filler words ("just"), consider rephrasing the paragraph instead of removing it, or note in the PR description that some documentation content is being intentionally trimmed.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

docs/ECH.md

lib/ftp.c

Everywhere. In documentation and code comments. It is almost never a good word and almost always a filler that should be avoided. Closes #20793

It is almost never a good word and almost always a filler that should be avoided. Copied the badwords.pl script from curl/curl to here, and the badwords.txt from there to sync up. Ref: curl/curl#20793

docs/cmdline-opts/write-out.md

It is almost never a good word and almost always a filler that should be avoided. Copied the badwords.pl script from curl/curl to here, and the badwords.txt from there to sync up. Ref: curl/curl#20793 Closes #584

It's mostly a filler word. I've read through each use of it in the code base and did minor rephrasings when "simply" carried some meaning. The overwhelming majority of cases, removing it improved the text significantly. Inspired by #20793. Closes #20822

jstangroome · 2026-03-19T00:03:39Z

docs/examples/adddocsref.pl

        my $l = $_;
        if($l =~ /\/* $docroot/) {
-            # just ignore preciously added refs
+            # ignore preciously added refs


Noticed possible pre-existing typo:

Suggested change

# ignore preciously added refs

# ignore previously added refs

Would you like to make a PR?

noticed while reviewing curl#20793

noticed while reviewing #20793 Ref: https://github.com/curl/curl/pull/20793/changes#r2957089487 Closes #21001

bagder added the documentation label Mar 2, 2026

github-actions bot added cmdline tool libcurl API tests CI Continuous Integration labels Mar 2, 2026

bagder requested a review from Copilot March 2, 2026 23:00

bagder marked this pull request as ready for review March 2, 2026 23:00

Copilot started reviewing on behalf of bagder March 2, 2026 23:00 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

docs/INSTALL-CMAKE.md Outdated Show resolved Hide resolved

docs/libcurl/libcurl.m4 Outdated Show resolved Hide resolved

docs/libcurl/curl_global_trace.md Show resolved Hide resolved

augmentcode bot reviewed Mar 2, 2026

View reviewed changes

docs/EARLY-RELEASE.md Outdated Show resolved Hide resolved

docs/libcurl/curl_mprintf.md Outdated Show resolved Hide resolved

bagder requested a review from Copilot March 3, 2026 07:10

Copilot started reviewing on behalf of bagder March 3, 2026 07:11 View session

Copilot AI reviewed Mar 3, 2026

View reviewed changes

docs/ECH.md Show resolved Hide resolved

lib/ftp.c Outdated Show resolved Hide resolved

bagder added 2 commits March 3, 2026 08:36

stop using the word 'just'

c45ad19

Everywhere. In documentation and code comments. It is almost never a good word and almost always a filler that should be avoided. Closes #20793

badwords.txt: add 'just' - as a test for starters

fc70997

bagder force-pushed the bagder/avoid-just branch from 1682970 to fc70997 Compare March 3, 2026 07:36

bagder mentioned this pull request Mar 3, 2026

avoid the word 'just' curl/everything-curl#584

Closed

liamlaverty reviewed Mar 3, 2026

View reviewed changes

docs/cmdline-opts/write-out.md Outdated Show resolved Hide resolved

fixup the write-out wording

9660b62

bagder closed this in b4dba34 Mar 3, 2026

bagder deleted the bagder/avoid-just branch March 3, 2026 14:30

felipedmesquita mentioned this pull request Mar 5, 2026

Avoid simply #20822

Closed

jstangroome reviewed Mar 19, 2026

View reviewed changes

jstangroome added a commit to jstangroome/curl that referenced this pull request Mar 19, 2026

fix apparent typo in comment

f07bdbd

noticed while reviewing curl#20793

jstangroome mentioned this pull request Mar 19, 2026

fix apparent typo in comment #21001

Closed

vszakats pushed a commit that referenced this pull request Mar 19, 2026

examples: fix typo in comment

ae864e8

noticed while reviewing #20793 Ref: https://github.com/curl/curl/pull/20793/changes#r2957089487 Closes #21001

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: stop using the word 'just'#20793

docs: stop using the word 'just'#20793
bagder wants to merge 3 commits intomasterfrom
bagder/avoid-just

bagder commented Mar 2, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bagder commented Mar 2, 2026

Uh oh!

augmentcode bot commented Mar 2, 2026

Uh oh!

augmentcode bot left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstangroome Mar 19, 2026

Uh oh!

vszakats Mar 19, 2026

Uh oh!

jstangroome Mar 19, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

	# ignore preciously added refs
	# ignore previously added refs

Uh oh!

Conversation

bagder commented Mar 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bagder commented Mar 2, 2026

Uh oh!

augmentcode bot commented Mar 2, 2026

Uh oh!

augmentcode bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstangroome Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

vszakats Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

jstangroome Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants