-
Notifications
You must be signed in to change notification settings - Fork 28
[DOC] Enhanced doc for CGI.new #80
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
Conversation
- Fix accept_charset option description to clarify HTTP header vs config behavior - Add note about max_multipart_length being internal-only (no public getter) - Update pretty_inspect example to show accurate @accept_charset value - Add 'Options vs Public Methods' section explaining internal vs external APIs - Improve clarity around class default encoding vs method behavior These changes address accuracy issues while preserving the excellent structural improvements from the original enhanced documentation.
- Add test_cgi_new.rb with 11 tests covering all CGI.new functionality - Test all documented options: accept_charset, max_multipart_length, tag_maker - Validate all HTML versions: html3, html4, html4Tr, html4Fr, html5 - Test offline mode, encoding error handling, and option combinations - Verify accept_charset method behavior (HTTP header vs configuration) - Ensure proper integration with existing test suite - 100% pass rate with comprehensive coverage of enhanced documentation The test suite validates both the functionality and the accuracy of the enhanced CGI.new documentation.
|
@BurdetteLamar thanks for this work. I evaluated the changes and found some of the documented behaviour was not aligned with the implementation. Do you mind reviewing my documentation changes? I also added tests (which test what the documentation asserts is true). |
|
FYI, it looks like the behaviour of Previously: |
ioquatix
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
With some minor changes. LGTM. Thanks.
|
Thanks, @ioquatix. I'm good with this change. Is the difference b/c I'm using an out-of-date CGI (0.5.-0, in Ruby version 3.4.5)? |
|
@ioquatix, also, I don't like to merge my own work, so when you're satisfied, please feel free to merge. |
No description provided.