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

improve docstrings of makeUniversal templates, allow extensions #631

Merged
merged 1 commit into from
Mar 2, 2024

Conversation

Vindaar
Copy link
Collaborator

@Vindaar Vindaar commented Mar 2, 2024

Each makeUniversal call accepts a docSuffix argument, which can be used to provide an additional piece of text to be added to that calls doc.

@AngelEzquerra: Feel free to adjust any of the makeUniversal calls in ufunc.nim and give some extra information. It will just be added as a paragraph to the autogenerated text.

Note: The previous comment

# Note, the makeUniversal/Local documentation gets duplicated in docs at each template call
# And shouldn't use ##

in the code seems to be outdated. This does not seem to happen anymore. Therefore I've made the doc string of the two templates regular ## doc comments.

Each `makeUniversal` call accepts a `docSuffix` argument, which can be
used to provide an additional piece of text to be added to that calls doc.
Copy link
Contributor

@AngelEzquerra AngelEzquerra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just tested it and it works great! Thank you!

@Vindaar Vindaar merged commit 7f9359b into mratsim:master Mar 2, 2024
6 checks passed
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 this pull request may close these issues.

2 participants