-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changing @stencil
docs to correctly reflect func_or_mode
param
#3594
Changes from 2 commits
fc03f05
1259c40
03f0bfc
b7d223f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -171,10 +171,10 @@ specified neighborhood, **the behavior is undefined.** | |
|
||
.. _stencil-mode: | ||
|
||
``mode`` | ||
``func_or_mode`` | ||
-------- | ||
|
||
The optional mode parameter controls how the border of the output array | ||
The optional func_or_mode parameter controls how the border of the output array | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Done! (Sorry for the delay) |
||
is handled. Currently, there is only one supported value, ``"constant"``. | ||
In ``constant`` mode, the stencil kernel is not applied in cases where | ||
the kernel would access elements outside the valid range of the input | ||
|
@@ -186,7 +186,7 @@ to a constant value, as specified by the ``cval`` parameter. | |
|
||
The optional cval parameter defaults to zero but can be set to any | ||
desired value, which is then used for the border of the output array | ||
if the mode parameter is set to ``constant``. The cval parameter is | ||
if the func_or_mode parameter is set to ``constant``. The cval parameter is | ||
ignored in all other modes. The type of the cval parameter must match | ||
the return type of the stencil kernel. If the user wishes the output | ||
array to be constructed from a particular type then they should ensure | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Title underline needs extending to the same number of chars as the title. Docs are built with warning-as-error so I think this will fail to build.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@AaronCritchley, I've fixed this in b7d223f.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for fixing, sorry for not catching this, I didn't build the docs after my change, lesson learnt 馃槃
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem. Thanks for instigating these changes, the stencil options read better now!