Teamwork / Teamwork/kommentaar

Ability to add private documentation to references

Open
#47 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
34
Forks
6
Avg merge
14h 5m
Merged PRs (30d)
2

Description

Right now all the godoc comments for references are added to the Kommentaar output. Sometimes it might be useful to have just some internal/private notes.

I can't really think of an elegant way of doing that. Only way I can think of is something along the lines of:

// Foo is a bar.
//
// {private}
// Not in Kommentaar output.
type Foo struct {
    // Public stuff.
    //
    // {private}
    // This is not in the Kommentaar output.
    Name
}

but I can't say I'm especially impressed by that. Alternatives to {private} might be ---, or something else.

Need to think about it. Suggestions welcome.

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

Start by reviewing the proposed private-comment syntax and the unresolved suggestions in this issue. Decide how private notes should be marked and how they should affect Kommentaar output for references, then define tests that demonstrate private notes are excluded while public godoc comments remain.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.