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

make docs #25

Closed
ArnoStrouwen opened this issue Aug 30, 2022 · 4 comments · Fixed by #30
Closed

make docs #25

ArnoStrouwen opened this issue Aug 30, 2022 · 4 comments · Fixed by #30

Comments

@ArnoStrouwen
Copy link
Member

No description provided.

@devmotion
Copy link
Member

Isn't it documented already in the SciML docs? https://docs.sciml.ai/stable/modules/MuladdMacro/

The package only defines @muladd and that is explained quite elaborately there it seems. The docstring is a bit shorter:

"""
@muladd
Convert every combination of addition/subtraction and multiplication to a call of `muladd`.
If both of the involved operators are dotted, `muladd` is applied as a dot call.
The order of summation might be changed.
"""

@ArnoStrouwen
Copy link
Member Author

I think it would be better if the unified docs pointed towards documentation folder, instead of the readme.
That way we can activate strict docs and make sure non of the examples break.

@devmotion
Copy link
Member

I don't think this package will ever change, so this is a bit of a special case here. It has zero dependencies so also no other package can break it.

@ChrisRackauckas
Copy link
Member

Yeah I'm not sure if this really needs a full docs, it's just one macro. The README seems fine for this one.

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

Successfully merging a pull request may close this issue.

3 participants