Documentation: Fix grammar, spelling, and wording errors #164
Conversation
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
…to copilot/sub-pr-163
Co-authored-by: clauspruefer <17313789+clauspruefer@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR provides comprehensive corrections of grammar, spelling, and wording errors across documentation files in the /doc directory. The changes aim to improve documentation quality through spelling corrections, grammar fixes, terminology standardization, and section numbering corrections.
Key Changes:
- Spelling corrections: Fixed typos like
wil→will,apended→appended,dependend→dependent,regulary→regularly,Construtor→Constructor,Rendererd→Rendered - Grammar improvements: Subject-verb agreement (
is→are), article usage (a HTTP→an HTTP), possessives corrections - Technical terminology standardization:
Posix Thread→POSIX Thread,32bit→32-bit,Loop on→Iterate over
Critical Issues Found:
- Variable name changes in HTTPLib.rst don't match actual code implementation (
_SplittedRequestsvs_SplitRequests) - HTTP escape sequence corrections use wrong order (
\n\rinstead of\r\n)
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| TerminationHandling.rst | Fixed plural form: "child PID" → "child PIDs" for grammatical correctness |
| StaticFSHandler.rst | Corrected spelling "dependend" → "dependent", article "a HTTP" → "an HTTP", possessive "files" → "file's" |
| ResultScheduler.rst | Fixed word order: "never will" → "will never" for proper grammar |
| ResultProcessor.rst | Updated section numbering from "1.5.x" to "8.5.x" to match document structure; improved wording "Loop on" → "Iterate over" |
| README.md | Fixed typos: "regulary" → "regularly", "Rendererd" → "Rendered" |
| Overview.rst | Standardized technical terms: "Posix" → "POSIX", "32bit" → "32-bit"; removed markdown formatting from RST |
| Main-Server.rst | Corrected spelling: "configuation" → "configuration", compound word "Filedescriptor" → "File Descriptor" |
| IPCHandler.rst | Fixed typo in section header: "Construtor" → "Constructor" |
| HTTPLibNet.rst | Improved wording by removing informal qualifiers: "quite sub-optimal" → "sub-optimal", "very small library" → "small library" |
| HTTPLib.rst | Multiple corrections including spelling fixes and variable name changes (issues identified with code mismatch) |
| ClientHandler.rst | Fixed possessive: "Client Objects Buffer" → "Client Object's Buffer" |
| CPPClasses.rst | Minor wording improvement: "found here" → "found at" |
| ASProcessHandler.rst | Improved terminology: "Loop on" → "Iterate over" for consistency |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * POST Requests (with Content-Length header and bytes[size] after "\\n\\r" end marker) | ||
| * Multiple HTTP "messages" in one TCP packet | ||
| * Fragmented (partial) messages without end marker "\n\r" (GET) or "Content-Length" (POST) | ||
| * Fragmented (partial) messages without end marker "\\n\\r" (GET) or "Content-Length" (POST) |
There was a problem hiding this comment.
The escape sequence order is incorrect. The documentation shows "\n\r" but the actual HTTP protocol and code implementation use "\r\n" (CRLF - Carriage Return Line Feed). The correct sequence should be "\r\n" to match the actual implementation in httpparser.cpp which uses "\r\n\r\n" as the HTTP header/body separator.
| 2. All requests inside _HTTPRequest buffer get split by "\n\r" or "\n\r"+Content-Length | ||
| 3. Single requests will be put inside _SplittedRequests Vector | ||
| 1. _SplitRequests Vector will be cleared | ||
| 2. All requests inside _HTTPRequest buffer are split by "\\n\\r" or "\\n\\r"+Content-Length |
There was a problem hiding this comment.
The escape sequence order is incorrect. The documentation shows "\n\r" but the actual HTTP protocol and code implementation use "\r\n" (CRLF - Carriage Return Line Feed). The correct sequence should be "\r\n" to match the actual implementation in httpparser.cpp which uses "\r\n\r\n" as the HTTP header/body separator.
| 1. _SplittedRequests Vector will be cleared | ||
| 2. All requests inside _HTTPRequest buffer get split by "\n\r" or "\n\r"+Content-Length | ||
| 3. Single requests will be put inside _SplittedRequests Vector | ||
| 1. _SplitRequests Vector will be cleared |
There was a problem hiding this comment.
The variable name _SplitRequests does not match the actual variable name in the code. The actual implementation uses _SplittedRequests (see lib/http/httpparser.hpp line 51 and lib/http/httpparser.cpp). Documentation should reflect the actual code, even if the code variable name contains a grammatical error. Either the code should be refactored to use _SplitRequests, or the documentation should remain as _SplittedRequests.
| 3. Single requests will be put inside _SplittedRequests Vector | ||
| 1. _SplitRequests Vector will be cleared | ||
| 2. All requests inside _HTTPRequest buffer are split by "\\n\\r" or "\\n\\r"+Content-Length | ||
| 3. Single requests will be put inside _SplitRequests Vector |
There was a problem hiding this comment.
The variable name _SplitRequests does not match the actual variable name in the code. The actual implementation uses _SplittedRequests (see lib/http/httpparser.hpp line 51 and lib/http/httpparser.cpp). Documentation should reflect the actual code, even if the code variable name contains a grammatical error. Either the code should be refactored to use _SplitRequests, or the documentation should remain as _SplittedRequests.
|
|
||
| 1. Set SHM Base Address (SHMGetRequests) | ||
| 2. Foreach _SplittedRequests Vector Element: call _parseBaseProps(&Request, ASRequestHandlerRef) | ||
| 2. For each _SplitRequests Vector Element: call _parseBaseProps(&Request, ASRequestHandlerRef) |
There was a problem hiding this comment.
The variable name _SplitRequests does not match the actual variable name in the code. The actual implementation uses _SplittedRequests (see lib/http/httpparser.hpp line 51 and lib/http/httpparser.cpp). Documentation should reflect the actual code, even if the code variable name contains a grammatical error. Either the code should be refactored to use _SplitRequests, or the documentation should remain as _SplittedRequests.
|
|
||
| * GET Requests (without Content-Length header) | ||
| * POST Requests (with Content-Length header and bytes[size] after "\n\r" end marker | ||
| * POST Requests (with Content-Length header and bytes[size] after "\\n\\r" end marker) |
There was a problem hiding this comment.
The escape sequence order is incorrect. The documentation shows "\n\r" but the actual HTTP protocol and code implementation use "\r\n" (CRLF - Carriage Return Line Feed). The correct sequence should be "\r\n" to match the actual implementation in httpparser.cpp which uses "\r\n\r\n" as the HTTP header/body separator.
Comprehensive correction of grammar, spelling, and wording errors across all
/docdocumentation files.Spelling Corrections
wil→will,apended→appended,SatticFS→StaticFS,configuation→configuration,regulary→regularly,dependend→dependent,Construtor→Constructor,Rendererd→RenderedGrammar Fixes
IPCHandler.hpp and IPCHandler.cpp is used→are useda HTTP request→an HTTP requestfiles properties→file's properties,Client Objects Buffer→Client Object's Bufferchild PID (ResultProcessor, multiple ASProcessHandler PIDs) were→child PIDs...wereWording & Consistency
Loop on→Iterate over,Foreach→For each,split up in→divided intoPosix Thread→POSIX Thread,32bit→32-bitget split by→are split byquite sub-optimal→sub-optimal,very small library→small library1.5.1→8.5.1in ResultProcessor.rstFiles Modified
HTTPLib.rst, Overview.rst, Main-Server.rst, ClientHandler.rst, ASProcessHandler.rst, StaticFSHandler.rst, ResultProcessor.rst, Configuration.rst, ResultScheduler.rst, IPCHandler.rst, HTTPLibNet.rst, MemoryAlignment.rst, TerminationHandling.rst, CPPClasses.rst, Graphical-Workflows.rst, README.md
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.