Start what's new for 1.0

[minrk]

minor fixes along the way:

• updates to tools/gh_api for getting the stats
• raise AttributeError, not ImportError in ShimModule - the __import__ call will raise the ImportError if there should be one.

[Carreau]

Btw, just before taking my flight. I think that github support uploads
again. They call it realeases IIRC.

Le samedi 20 juillet 2013, Min RK a écrit :

minor fixes along the way:

• updates to tools/gh_api for getting the stats
• raise AttributeError, not ImportError in ShimModule - the __import__call will raise the ImportError if there should be one.

---

You can merge this Pull Request by running

git pull https://github.com/minrk/ipython whatsnew

Or view, comment on, or merge it at:

#3704
Commit Summary

• add auth and paged request to gh_api
• checkpoint
• raise AttributeError on missing attribute in ShimModule
• updates to github stats
• start 1.0 whatsnew

File Changes

• M IPython/frontend.pyhttps://github.com/Start what's new for 1.0 #3704/files#diff-0(2)
• M docs/source/whatsnew/development.txthttps://github.com/Start what's new for 1.0 #3704/files#diff-1(44)
• A docs/source/whatsnew/github-stats-1.0.txthttps://github.com/Start what's new for 1.0 #3704/files#diff-2(1463)
• M docs/source/whatsnew/index.txthttps://github.com/Start what's new for 1.0 #3704/files#diff-3(2)
• A docs/source/whatsnew/version1.0.txthttps://github.com/Start what's new for 1.0 #3704/files#diff-4(277)
• M tools/gh_api.pyhttps://github.com/Start what's new for 1.0 #3704/files#diff-5(60)
• M tools/github_stats.pyhttps://github.com/Start what's new for 1.0 #3704/files#diff-6(93)

Patch Links:

• https://github.com/ipython/ipython/pull/3704.patch
• https://github.com/ipython/ipython/pull/3704.diff

[minrk]

That's true, I will look at what's involved.

[takluyver]

I suspect that in many cases, people might not want to import IPython to test whether their code is running in an IPython session. Do we have a convenient and official way to do that?

[minrk]

Well, the current de facto standard is

try:
    ip = get_ipython()
except NameError:
    ip = None

But this is only true for code called from within the builtins_trap, which we found can be not true in some cases, such as when loading extensions at startup, etc.

How else can we provide a function for checking IPython, other than a function imported from IPython or injected into builtins?

[takluyver]

Well, that raises a more complex issue of exactly what we mean by code 'running in IPython'. But if that's a common case, one obvious approach would be to set a builtin, or some other globally accessible variable, all the time that IPython is running.

Alternatively, we could provide a function to copy&paste that checks whether IPython is in sys.modules, and only calls IPython.get_ipython() if it is.

[minrk]

I think that's appropriate. I guess the function would be:

def get_ipython():
    import sys
    if 'IPython' in sys.modules:
        import IPython
        return IPython.get_ipython()

[takluyver]

👍

[dpsanders]

@minrk Update nbconvert syntax:

Line 157:

ipython nbconvert --format full_html *.ipynb

ipython nbconvert --to html *.ipynb

Line 186:

simply set InlineBackend.figure_format = 'retina' for 2x PNG figures.

Replace with:

simply use %config InlineBackend.figure_format = 'retina' for 2x PNG figures.

[Carreau]

Replace with:
simply use %config InlineBackend.figure_format = 'retina' for 2x PNG figures.

Disagree, set is more general, you can do it in your config file, or at the command line. %config does not persist (yet)

[dpsanders]

You are of course correct; my point is that how is somebody supposed to
know how to do any of these things? At least I gave one concrete way to do
it.

I guess alternatively we could just put a link to the config docs.
Perhaps a more narrative introduction should be in notebook.rst, rather
than just a link?

On Mon, Aug 5, 2013 at 2:29 AM, Matthias Bussonnier <
notifications@github.com> wrote:

Replace with:
simply use %config InlineBackend.figure_format = 'retina' for 2x PNG
figures.

Disagree, set is more general, you can do it in your config file, or at
the command line. %config does not persist (yet)

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/3704#issuecomment-22090805
.

Dr. David P. Sanders

Profesor Titular "A" / Associate Professor
Departamento de Física, Facultad de Ciencias
Universidad Nacional Autónoma de México (UNAM)

dpsanders@gmail.com
http://sistemas.fciencias.unam.mx/~dsanders

Cubículo / office: #414, 4o. piso del Depto. de Física

Tel.: +52 55 5622 4965

[Carreau]

You are of course correct; my point is that how is somebody supposed to
know how to do any of these things? At least I gave one concrete way to do
it.

There is always a delicate balance between saying too much and too little.Here we jus inform people with retina-display that they can enable it. They are probably a minority, and I don't think it is worth giving more info. If you give too much info or one-liner on how to do something then people don't learn. Using the word "set" implicitly state that you have to configure something, so you look for configuration. Once you know our configuration system then you know how to configure everything else. So it is small difficulty for the user, but he will gain a lot by surpassing it, it will also remove us the pain of describing on every configuration option in all the doc how to configure.

As for %config, not everything can be changed at load time with %config , so it can confuse user.

Still it is true that the config docs might be a little too much for a new user and we should probably have a simple introduction doc just about config files and how to write them.