JuliaImages / JuliaImages/ImageFeatures.jl
docstring missing
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 49
- Forks
- 31
- PR merge metrics
- No merged PRs in 30d
Description
The current julia documentation fails to build: https://github.com/JuliaImages/juliaimages.github.io/issues/44#issuecomment-453773548
When building Images.jl Documentation https://github.com/JuliaImages/juliaimages.github.io with Documenter v0.22, there'll be lots of unresolved links if using @docs macro in function_reference.md
```@docs
glcm
...
``` #
and glcm doesn't have its docstring
help?> glcm
search: glcm glcm_prop glcm_norm glcm_var_ref glcm_entropy glcm_mean_ref glcm_symmetric glcm_var_neighbour
No documentation found.
To supprese the no-doc-found warnings, I temporarily changed @docs to julia in https://github.com/JuliaImages/juliaimages.github.io/pull/50
The following is a list of undocumented methods
- glcm
- glcm_symmetric
- glcm_norm
- glcm_prop
- max_prob
- contrast
- ASM
- IDM
- glcm_entropy
- energy
- dissimilarity
- correlation
- glcm_mean_ref
- glcm_mean_neighbour
- glcm_var_ref
- glcm_var_neighbour
- lbp
- modified_lbp
- direction_coded_lbp
- lbp_original
- lbp_uniform
- lbp_rotation_invariant
- multi_block_lbp
cc: @timholy
Contributor guide
No contributing guide indexed for this repository
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 with the undocumented functions listed in the issue and the function_reference.md entry using Documenter’s @docs macro. Locate their Julia definitions, then document the listed methods and rebuild the Images.jl documentation with Documenter v0.22. Done means the documented entries no longer produce unresolved-link or no-documentation warnings.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- computer-vision, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100