Skip to content
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

Missing documentation of Rex::Interface::Connection namespace #1578

Open
ferki opened this issue Mar 2, 2023 · 0 comments
Open

Missing documentation of Rex::Interface::Connection namespace #1578

ferki opened this issue Mar 2, 2023 · 0 comments
Labels
bug Confirmed bugs docs needed A topic that needs documentation

Comments

@ferki
Copy link
Member

ferki commented Mar 2, 2023

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

@ferki ferki added bug Confirmed bugs docs needed A topic that needs documentation labels Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Confirmed bugs docs needed A topic that needs documentation
Projects
None yet
Development

No branches or pull requests

1 participant