Docs should wrap at line limit, not at "\n"
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Kotlin
- Stars
- 4.4k
- Forks
- 627
- Avg merge
- 3d 15m
- Merged PRs (30d)
- 20
Description
Proto:
enum Option {
/**
* This is the default option. Its documentation should wrap not at
* the "\n" symbol but at the right place according to the line limit.
*/
DEFAULT = 1;
}
generates:
enum class Option(
override val value: Int
) : WireEnum {
/**
* This is the default option. Its documentation should wrap not at
* the "\n" symbol but at the right place according to the line limit.
*/
DEFAULT(1);
...
should be:
enum class Option(
override val value: Int
) : WireEnum {
/**
* This is the default option. Its documentation should wrap not at the "\n" symbol but at the
* right place according to the line limit.
*/
DEFAULT(1);
...
Contributor guide
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 by reproducing the issue with the Proto enum and documentation shown in the report, then trace the generator path that produces Kotlin enum KDoc. The fix is complete when the generated comment wraps at the configured line limit rather than at the literal "\n" text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kotlin
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100