Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

image/color: documentation doesn't include links to relevant color theory resources #37188

Open
dolmen opened this issue Feb 12, 2020 · 1 comment

Comments

@dolmen
Copy link

@dolmen dolmen commented Feb 12, 2020

What version of Go are you using (go version)?

$ go version
1.13.7

Does this issue reproduce with the latest release?

Yes: https://tip.golang.org/pkg/image/color/

What did you expect to see?

The image/color relies on some color theory. But no pointers are given to learn about that theory.

Here are a few questions for which the documentation should give answers or even just hints:

  • What is Alpha?
  • What is the difference between alpha-premultiplied and non-alpha-premultiplied (some answer exists in doc for type RGBA, but more in overview would be helpful) and when should one be used).

Also, no examples. That would be useful to understand Model.

What did you see instead?

The package overview section is a single sentence:

Package color implements a basic color library.

@dmitshur dmitshur changed the title image/color lacks doc image/color: documentation doesn't include links to relevant color theory resources Feb 14, 2020
@dmitshur dmitshur added this to the Backlog milestone Feb 14, 2020
@dmitshur
Copy link
Member

@dmitshur dmitshur commented Feb 14, 2020

There were some old blog posts on image packages at https://blog.golang.org/go-image-package and https://blog.golang.org/go-imagedraw-package that have additional relevant information. Perhaps linking to those is a good idea.

/cc @robpike per owners. Also /cc @nigeltao.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.