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

JLayers docstring needs update #382

Closed
Wikunia opened this issue Aug 5, 2021 · 4 comments · Fixed by #383
Closed

JLayers docstring needs update #382

Wikunia opened this issue Aug 5, 2021 · 4 comments · Fixed by #383
Labels
documentation Improvements or additions to documentation

Comments

@Wikunia
Copy link
Member

Wikunia commented Aug 5, 2021

Currently the docstring of JLayer see: https://wikunia.github.io/Javis.jl/stable/references/#Javis.@JLayer-Tuple{Expr,Int64,Int64,Any,QuoteNode,Expr}
misses the transparent inside the function arguments and I think we should write :transparent and :opaque as code

The docstring of to_layer_m should also me updated and maybe we should call it _to_layer as it is an internal method that is normally not called by the user?

Maybe you @Sov-trotter can fix this 😉

@Wikunia Wikunia added the documentation Improvements or additions to documentation label Aug 5, 2021
@EnzioKam
Copy link
Contributor

Just want to also point out that for the example in the docstring, the object is at red_ball = Object(20:60, (args...)->object(O, "red"), Point(50,0)) might be confusing, since there is no object function defined in the example.

Maybe consider replacing object with circle or other shapes, or adding the object function into the docstring's example itself?

@Wikunia
Copy link
Member Author

Wikunia commented Aug 18, 2021

Yes good point. I think we might want to use JCircle when possible to also remove the explicit anonymous functions everywhere

@Sov-trotter
Copy link
Member

Sov-trotter commented Aug 18, 2021

I think we might want to use JCircle when possible to also remove the explicit anonymous functions everywhere

@Wikunia I am not sure if I can agree on that one. This would present shorthands as mainstream Javis way of defining objects which is not good as shorthands are just an easy way of representing anonymous functions.

It's like giving a mathematical formula without deriving it. 😅

@Wikunia
Copy link
Member Author

Wikunia commented Aug 18, 2021

I think it makes sense to start with the anonymous functions in the tutorials as we do. However for docstrings it should be preferably be all possible without defining specific functions in each of them. Another option would be to use JShape to be more general as one doesn't really need the anonymous function anymore when one can use JShape.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants