GuangchuangYu / GuangchuangYu/hexSticker

please describe parameter ranges in more detail in sticker.Rd

Open
#50 0 comments 7 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
813
Forks
179
Avg merge
45m
Merged PRs (30d)
1

Description

A nice & potentially useful package, but w/o more detailed description of the parameters and their ranges, one is left to guess what they might be, and then iterate to find something that works.

p_x, p_y, s_x, s_y, s_height, s_width, ... ? What is the frame of reference for *_x., *_y positions? What is the relation of *_height, *_width to this?

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

Open sticker.Rd and review the documented parameters p_x, p_y, s_x, s_y, s_height, and s_width. Clarify the frame of reference for *_x and *_y positions, explain how *_height and *_width relate to it, and document the relevant parameter ranges; done means readers no longer need to guess or iterate to find usable values.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.