diff options
| author | Edouard CHIN <chin.edouard@gmail.com> | 2025-07-23 16:10:50 +0200 |
|---|---|---|
| committer | Hiroshi SHIBATA <hsbt@ruby-lang.org> | 2025-07-25 11:10:41 +0900 |
| commit | 4dd708bf5d833c3999c786169abfcfc79cd4e676 (patch) | |
| tree | 827ccf5f679fa4b22db6c787a00391d8b1d583fd /test/ruby/test_rubyvm.rb | |
| parent | 80712140af4229eec4da4e68cf7aaf6a659f5a85 (diff) | |
[rubygems/rubygems] Add a quality spec to ensure man pages are up to date:
- Ref #8802
- ### Problem
Whenever a bundler command options is added, we want to make
sure that the associated command man page is updated to reflect
the new option (e.g. this mistake was made in #8624)
### Solution
In #8802 we discussed a bit on the implementation which would rely
on parsing ronn files and introduce some conventions on how options
documented in man pages should be written.
I figured I would try a simpler approach by just checking if the man
page of a command list options using a simple regex.
Pros:
- Simpler as we don't have to parse ronn files.
- No need to modify all existing man pages.
Cons:
- We can only verify one way (CLI options -> man pages).
If a CLI option get removed, we won't be able to warn that
the existing document man page option needs to be removed.
https://github.com/rubygems/rubygems/commit/e10e60bd33
Diffstat (limited to 'test/ruby/test_rubyvm.rb')
0 files changed, 0 insertions, 0 deletions
