[sagenb] 135/157: Add information about generating keys

[felix salfelder]

This is an automated email from the git hooks/post-receive script.

felix-guest pushed a commit to branch master
in repository sagenb.

commit 4704800a018148a819d08d962cc9ed0bbd48097b
Author: kcrisman <kcrisman at gmail.com>
Date:   Mon Nov 3 09:15:54 2014 -0500

    Add information about generating keys
    
    We didn't say what `secure=True` does about keys, and given the likelihood of things like https://groups.google.com/forum/#!topic/sage-support/zglN_3QLCPo happening again in the future, it is a good idea to document this better.
    
    HT to Jori Mäntysalo for this placement and essentially the wording.
---
 sagenb/notebook/notebook_object.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/sagenb/notebook/notebook_object.py b/sagenb/notebook/notebook_object.py
index 431b187..1720dab 100644
--- a/sagenb/notebook/notebook_object.py
+++ b/sagenb/notebook/notebook_object.py
@@ -48,6 +48,12 @@ class NotebookObject:
           must have OpenSSL installed to use this feature, or if you compile
           Sage yourself, have the OpenSSL development libraries installed.
           *Highly recommended!*
+          
+          When ``notebook()`` is run for first time with ``secure=True``, it
+          will generate new keys and store them to ``.sage/notebook/``.
+          Remove this when you want to generate new keys, for example if an
+          older version of Sage has generated keys that are too short for
+          current browsers.
 
         - ``reset`` -- boolean (default: ``False``) if True allows you
           to set the admin password.  Use this if you forget your

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/sagenb.git