masukomi / masukomi/private_comments
add ability to generate a file with the comments inlined.
Nobody has claimed this yet.
- Dominant language
- Scheme
- Stars
- 48
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
I'm thinking something like
`pc -f /path/to/file.rb -g`
`g` for "generate"
this would build a version of the file with the comments inserted inline.
## open questions:
* should they be commented using the single line comment format of the language of the given file?
* if so, what about files with unknown language extensions?
* should they be before the line they are commenting on or after? I'm leaning towards before.
Contributor guide
No contributing guide indexed for this repository
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 with the `pc` command and the `-f /path/to/file.rb -g` entry point described in the issue. Before implementation, resolve the open questions about language-specific comment syntax, unknown extensions, and whether comments appear before or after the referenced line; done means generating a file with the comments inlined.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100