Missing documentation of Rex::Interface::Connection namespace
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 737
- Forks
- 214
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
Rex::Interface::Connection namespace lacks documentation.
Expected behavior
It would be nice to document at least the publicly exposed and/or commonly used bits of the Rex::Interface::Connection namespace, for example the server() method to get the current server.
How to reproduce it
Open any of the Rex::Interface::Connection modules with perldoc
Code example
perldoc Rex::Interface::Connection
Additional context
It is a follow-up issue from #933.
Rex version
1.14.0
Perl version
5.36.0
Operating system running rex
Gentoo
Operating system managed by rex
local
How rex was installed?
dzil install
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 by running perldoc Rex::Interface::Connection and inspecting the Rex::Interface::Connection modules it reports. Document the publicly exposed or commonly used namespace members, including the server() method, so the namespace has useful perldoc coverage.
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
- 38/100