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

Improve Automated Documentation #29

Open
bodo-hugo-barwich opened this issue May 30, 2023 · 1 comment
Open

Improve Automated Documentation #29

bodo-hugo-barwich opened this issue May 30, 2023 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@bodo-hugo-barwich
Copy link
Owner

For greater reusability the in-code automated Documentation needs to be improved.

Its presentation on Meta-CPAN is crucial for the successful use.

@bodo-hugo-barwich
Copy link
Owner Author

Current progress of the automated documentation according to Pod::Coverage is:

$ perl -MPod::Coverage=Process::SubProcess -e ''
Process::SubProcess has a Pod::Coverage rating of 0.515151515151515
The following are uncovered: clearErrors, freeResources, getCommand, getErrorCode, getErrorString, getExecutionTime, getNameComplete, getProcessStatus, getReadTimeout, getReportString, getTimeout, isDebug, isProfiling, isRunning, setDebug, setProfiling
$ perl -MPod::Coverage=Process::SubProcess::Group -e ''
Process::SubProcess::Group has a Pod::Coverage rating of 0.129032258064516
The following are uncovered: Check, Kill, Launch, Run, Terminate, Wait, checkiProcess, clearErrors, freeResources, getCheckInterval, getErrorCode, getErrorString, getFinishedCount, getFreeCount, getProcessCount, getReadTimeout, getReportString, getRunningCount, getTimeout, getiProcess, isDebug, isProfiling, isQuiet, setDebug, setProfiling, setQuiet, setTimeout
$ perl -MPod::Coverage=Process::SubProcess::Pool -e ''
Process::SubProcess::Pool has a Pod::Coverage rating of 0
The following are uncovered: add, getFinishedProcess, getFreeProcess, getMaxProcessCount, getMinProcessCount, new, setMaxProcessCount, setMinProcessCount, waitFirst, waitNext
  • Process::SubProcess: 51.51%
  • Process::SubProcess::Group: 12.90%
  • Process::SubProcess::Pool: 0%

On Process::SubProcess rest mostly only the get methods to document which provides already a very good usability.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant