David Josephs
David Josephs
@danymat I believe this is good to be merged! As far as conventions go, I am still trying to figure out if/where any official guidelines exist, currently I am just...
actually hold on that, after reading https://docs.julialang.org/en/v1/manual/documentation/ more thoroughly i have some changes
I think for now this is probably sufficient but I will need to add more as I understand how julia documentation works!
Oh! I have forgotten to finish the job here, let me make these things!
So as far as conventions, Julia does not have established conventions like numpydoc jsdoc emmylua etc, so I guess we could just call it something like "Julia Alternative" or "Julia...
> Actually Julia defines some conventions in the [documentation](https://docs.julialang.org/en/v1/manual/documentation/) or more accurately in [Documenter.jl](https://juliadocs.github.io/Documenter.jl/stable/). > > Arguments are actually introduced with: > > ``` > """ > ... > #...
Here we go! Thank you by the way :)
new code sample! ```julia import Base: +, *, / """ Point(x,y) A struct representing a 2d point # Arguments - `x::Number` is the x coordinate - `y::Number` is the y...
> According to the documentation: > > * in [struct](https://docs.julialang.org/en/v1/manual/documentation/#Types) each field can be documented independently with no need of adding `arguments` in the struct docstring. > * in [arguments](https://docs.julialang.org/en/v1/manual/documentation/#Functions-and-Methods)...
So need to figure out how to get the arguments in order, it is tricky because I have to parse typed and nontyped arguments separately, and default arguments I need...