JuliaImages / JuliaImages/juliaimages.github.io

document the difference between float32 and Float32, etc.

Open
#139 0 comments 2 reactions 0 assignees View on GitHub

@mgautam98 is already working on this.

Since Jul 1, 2020.

  • #146 by @mgautam98 — open
best practice
Dominant language
Julia
Stars
33
Forks
52
PR merge metrics
No merged PRs in 30d

Description

We need to advertise the usage of lower-cased form as it's simpler and more generic:

float32.(img) # promoting the storage type while preserving its colorant

Gray{Float32}.(img) # this could accidentally convert an RGB image to Gray image

Ref: https://github.com/JuliaImages/ImageQualityIndexes.jl/pull/20

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

Review linked pull request #146 and the issue examples first. Check the existing JuliaImages documentation around float32 and Float32 usage, then ensure it explains that lower-cased conversion preserves the colorant while the parameterized Gray form can change an RGB image to grayscale.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.