PDLPorters / PDLPorters/pdl

better document debug macros

Open
#393 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat:doc
Dominant language
Perl
Stars
105
Forks
49
PR merge metrics
No merged PRs in 30d

Description

As discussed with Ed, please add using debugging macros to the documents.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the existing project documentation and the debugging-macro discussion referenced in the issue. Identify which macros and usage examples need to be documented, then update the relevant documentation; the work is done when users can understand how to use the debugging macros.

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
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.