DOC: Description of image source method #42
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mgeier
reviewed
Oct 12, 2017
sfs/util.py
Outdated
| def image_sources_for_box(x, L, N, prune=True): | ||
| """Image source method for a cuboid room. | ||
|
|
||
| The classical method by Allen & Berkley [1]. |
There was a problem hiding this comment.
I get this error:
.../sfs/util.py:docstring of sfs.util.image_sources_for_box:26: WARNING: Footnote [1] is not referenced.
Is there some extension needed?
There was a problem hiding this comment.
Turns out I was using an older version of Sphinx where this was fine.
Updated.
mgeier
approved these changes
Oct 13, 2017
spors
approved these changes
Nov 27, 2017
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Mainly in
util.image_sources_for_box():description of source selection options
IMHO misleading parameter names changed