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

docstring missing #61

Open
23 tasks
johnnychen94 opened this issue Mar 29, 2019 · 3 comments
Open
23 tasks

docstring missing #61

johnnychen94 opened this issue Mar 29, 2019 · 3 comments

Comments

@johnnychen94
Copy link
Member

johnnychen94 commented Mar 29, 2019

The current julia documentation fails to build: JuliaImages/juliaimages.github.io#44 (comment)

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 JuliaImages/juliaimages.github.io#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

@Jay-sanjay
Copy link

is the issue resolved sir

@ashwani-rathee
Copy link
Member

It's not actually, as you might notice here: https://github.com/JuliaImages/ImageFeatures.jl/blob/master/src/brisk.jl all those functions are documented and we could use help :)

@Jay-sanjay
Copy link

Jay-sanjay commented Aug 31, 2023

Sir starting with first function glcm and the related glcm functions just needed to confirm https://github.com/JuliaImages/ImageFeatures.jl/blob/master/docs/src/tutorials/glcm.md?plain=1#L1-L26
I have to make changes in these .md files am I right ?

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

3 participants