Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Including a minimal unicode support for examples docstrings #19

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

Closed
wants to merge 6 commits into from

Conversation

Titan-C
Copy link
Member

@Titan-C Titan-C commented Feb 16, 2015

This is proposed as a short solution to address issue #18. Problem never arises in python 3 as unicode is default string. For dealing with python2 the use of the codecs module is included.

print('This is a long test Output\n'*50)
Copy link
Contributor

Choose a reason for hiding this comment

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

pep8 spaces around *

@agramfort
Copy link
Contributor

besides LGTM

I assume you tested :)



N = 50
x = np.linspace(-1,2,50)
Copy link
Member

Choose a reason for hiding this comment

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

Another PEP8 here

Copy link
Contributor

Choose a reason for hiding this comment

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

I am one who thinks that Unicode in source code is a bad thing. The reason is that Unicode characters are characters that not everybody can read or type. In a sens, not supporting it forces people not to use it, as they are never something necessary for an example.

Sent from my phone. Please forgive brevity and mis spelling

On Feb 17, 2015, 08:46, at 08:46, "Loïc Estève" [email protected] wrote:

+=======================================
+Únîcödè support in documentation string
+=======================================
+
+In this example we include Unicode characters that are so required
this days.✓
+"""
+
+# Code source: Óscar Nájera
+# License: BSD 3 clause
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+
+N = 50
+x = np.linspace(-1,2,50)

Another PEP8 here


Reply to this email directly or view it on GitHub:
https://github.com/sphinx-gallery/sphinx-gallery/pull/19/files#r24797986

Copy link
Member Author

Choose a reason for hiding this comment

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

I am one who thinks that Unicode in source code is a bad thing.

I think this more a matter of timing. As I said with python 3 having unicode as default implies the need for foreign languages support and that it is quite an issue. And this bug fix is not even necessary in python 3.
The reason I'm proposing this is not because of having unicode in the code. That already worked as you can find by checking that my examples included my Spanish accented name. And I agree that the source code should be the most plain text possible. I propose this because it is the main docstring of the example that could not include foreign characters. Docstrings are aimed for a broader audience than the programmers, so that they are most certainly are in the target audience most conforming setup, there every body would be able to read.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

Choose a reason for hiding this comment

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

TODO items before merge:

  • joblib must be replaced by shelve

Remarks for later (not preventing merge in nilearn)

  • _path_static should be renamed path_static, as it is used in the conf.py
  • the css names should be harmonized. In particular,  they should be all given w prefix, such as sphx-glr-...
  • functions should not be defined in closures: _select_block, _parse_dict_structure must be moved out of the function where they are defined
  • no @author in docstrings, but author as a comment in the beginning of a file,  with also the full name of the author, the original authors if any,  and "license: BSD"
  • the code isn't completely pep8: there should be two empty lines between first level functions
  • later: this code needs tests

Sent from my phone. Please forgive brevity and mis spelling

On Feb 17, 2015, 15:39, at 15:39, Gael Varoquaux [email protected] wrote:

I still don't see the value of non ASCII characters in the docstring.
You
and I have a non ASCII character in our name. But we accept perfectly
the
fact that we might get email without it.

Inversely, if you get an email, that says 'здравствуйте', it makes it
really hard for you to search your mailbox with this email. It makes it
hard to fix a typo in this mail... I am against the use of non-ASCII
character in a whole software project that is not specificaly about
localization.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry. I sent this to the wrong issue. That's the problem with reviewing
PRs on the phone. I'll put it elsewhere.

G

On Wed, Feb 25, 2015 at 09:26:54AM +0100, Gael Varoquaux wrote:

TODO items before merge:

  • joblib must be replaced by shelve

Remarks for later (not preventing merge in nilearn)

  • _path_static should be renamed path_static, as it is used in the conf.py
  • the css names should be harmonized. In particular, they should be all given
    w prefix, such as sphx-glr-...
  • functions should not be defined in closures: _select_block,
    _parse_dict_structure must be moved out of the function where they are defined
  • no @author in docstrings, but author as a comment in the beginning of a
    file, with also the full name of the author, the original authors if any, and
    "license: BSD"
  • the code isn't completely pep8: there should be two empty lines between first
    level functions
  • later: this code needs tests

Sent from my phone. Please forgive brevity and mis spelling

On Feb 17, 2015, at 15:39, Gael Varoquaux [email protected]
wrote:

I still don't see the value of non ASCII characters in the docstring. You
and I have a non ASCII character in our name. But we accept perfectly the
fact that we might get email without it.

Inversely, if you get an email, that says 'здравствуйте', it makes it
really hard for you to search your mailbox with this email. It makes it
hard to fix a typo in this mail... I am against the use of non-ASCII
character in a whole software project that is not specificaly about
localization.

Gael Varoquaux
Researcher, INRIA Parietal
Laboratoire de Neuro-Imagerie Assistee par Ordinateur
NeuroSpin/CEA Saclay , Bat 145, 91191 Gif-sur-Yvette France
Phone:  ++ 33-1-69-08-79-68
http://gael-varoquaux.info            http://twitter.com/GaelVaroquaux

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.

4 participants