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

Consolidate mathematical description of kernels between docs and docstrings #218

Closed
st-- opened this issue Jan 9, 2021 · 2 comments
Closed

Comments

@st--
Copy link
Member

st-- commented Jan 9, 2021

@willtebbutt wrote on #213:

I'm concerned is that we're duplicating documentation a bit at the minute by having both docstrings and having the entire Kernels section written out manually. This creates an opportunity for the docs to decouple from the docstrings and increases the maintenance burden. I wonder whether it would make sense, therefore, to consolidate this documentation -- if we were to move the concise mathematical description of the kernels from the docs to the docstrings, and just move /duplicate bits of the API section in the Kernel Functions section we could get the best of both worlds?

Originally posted by @willtebbutt in #213 (comment)

@devmotion
Copy link
Member

This is basically what I had in mind with the suggestion in #216 as well.

@devmotion
Copy link
Member

Closed by #236.

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

2 participants