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

Brief note about origin of Lena image #4785

Closed
wants to merge 2 commits into from

Conversation

aarchiba
Copy link
Contributor

No description provided.

@@ -327,6 +327,11 @@ def lena():
lena : ndarray
Lena image

Notes
-----
Though safe for work most places, this sexualized image is drawn from
Copy link
Member

Choose a reason for hiding this comment

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

Missing a preposition (is "in" the right one here?) between "work" and "most".

@rgommers
Copy link
Member

Good idea to add a note on this. Maybe it would also make sense to say something like:

This image has historically been used a lot for image processing
examples/applications and is kept for backwards compatibility. However for 
new code that needs an example image, we recommend to use `ascent` or `face`
instead of `lena`.

Also, I see now that ascent and face are not listed in misc/__init__.py or in the See Also of lena and therefore quite invisible. Could you fix that as well in this PR?

EDIT: IIRC ascent and face were added exactly to provide a better alternative to using lena

@rgommers rgommers added scipy.misc Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Apr 29, 2015
rgommers added a commit that referenced this pull request May 3, 2015
DOC: add a brief note about origin of Lena image
@rgommers
Copy link
Member

rgommers commented May 3, 2015

Squashed and merged in d9b221f with a very minor tweak (``` around function names in docstring instead of ' to create links, and prepend `DOC:` to commit message). Thanks @aarchiba!

@rgommers rgommers closed this May 3, 2015
@rgommers rgommers added this to the 0.16.0 milestone May 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.misc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants