Documentation lacks clear info which feature flags are activated by default
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 737
- Forks
- 214
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
In #1606 I learned I needed to use a more recent feature flag to get my desired behavior. So I went for 1.4 and had already trouble understand which other flags this would imply. I tried 1.4 only and just learned through pain that this does not include exec_autodie. I revisited the documentation and think this is not my fault.
Documentation for Rex 1.14.3 says on 1.4:
Furthermore, all features from earlier versions are activated.
The list of flags is quite long and it also contains conflicting flags like
autodieno_autodie
Expected behavior
Can you extend the documentation to include a list of what 1.4 and other meta flags actually mean?
How to reproduce it
perldoc Rex
Code example
No response
Additional context
No response
Rex version
1.14.3
Perl version
5.38
Operating system running rex
Linux
Operating system managed by rex
Linux
How rex was installed?
cpan client
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with lib/Rex.pm and the feature-flag section surfaced by perldoc Rex; inspect how the 1.4 and other meta flags are defined and expanded. Update the documentation with the effective flags for each meta flag, including conflicting entries such as autodie and no_autodie, and verify the rendered perldoc output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100