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

documentation on deprecating Integer type in favor of Normed #52

Open
johnnychen94 opened this issue Apr 28, 2019 · 3 comments
Open

documentation on deprecating Integer type in favor of Normed #52

johnnychen94 opened this issue Apr 28, 2019 · 3 comments
Assignees

Comments

@johnnychen94
Copy link
Member

johnnychen94 commented Apr 28, 2019

In JuliaImages images are stored using the following three datatypes:

  • FixedPointNumbers.Normed, e.g., N0f8, N0f16
  • AbstractFloat, e.g., Float32, Float64
  • Bool

⚠️ We don't represent images as array of Integer (except Bool)

We also need some documentation explaining the wrap around behavior of N0f8

related issues:

JuliaImages/ImageCore.jl#76 (comment)
JuliaImages/ImageCore.jl#72
JuliaMath/FixedPointNumbers.jl#41

@johnnychen94 johnnychen94 changed the title add documentation on deprecating Integer type and in favor of FixedPoint{Normed} add documentation on deprecating Integer type in favor of FixedPoint{Normed} Apr 28, 2019
@johnnychen94 johnnychen94 changed the title add documentation on deprecating Integer type in favor of FixedPoint{Normed} add documentation on deprecating Integer type in favor of Normed Apr 28, 2019
@timholy
Copy link
Member

timholy commented Apr 28, 2019

We already have quite a lot of documentation on this:

What's the specific proposal?

@johnnychen94
Copy link
Member Author

johnnychen94 commented Apr 28, 2019

Folks around me say the documentation is hard to read and understand. The first time I read the documentation in Aug 2018, I felt the same.
I'm planning to reorganize the current materials of JuliaImages documentation at some time point, this issue serves as a memo.

@johnnychen94 johnnychen94 self-assigned this Apr 28, 2019
@timholy
Copy link
Member

timholy commented Apr 28, 2019

I worry about that too. It will definitely help if other people work on it, it's always a bit dangerous when the person who writes the code also writes the documentation.

@johnnychen94 johnnychen94 changed the title add documentation on deprecating Integer type in favor of Normed documentation on deprecating Integer type in favor of Normed Apr 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants