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

Fix docstring in sage/crypto/boolean_function.pyx #12085

Closed
jdemeyer opened this issue Nov 26, 2011 · 11 comments
Closed

Fix docstring in sage/crypto/boolean_function.pyx #12085

jdemeyer opened this issue Nov 26, 2011 · 11 comments

Comments

@jdemeyer
Copy link
Contributor

Needed for upgrade to Python 2.7.2 (#9958). There is a problem with the math block in

    def annihilator(self,d, dim = False):
        """
        Return (if it exists) an annihilator of the boolean function of
        degree at most `d`, that is a Boolean polynomial `g` such that

        .. math::

            f(x)g(x) = 0 \forall x.

This results in

docstring of sage.crypto.boolean_function:4: WARNING: Block quote ends without a blank line; unexpected unindent.

Note that the warning does not at all refer to the function "annihilator". I had to do a binary search in the .pyx file to find where the problem lies.

Component: doctest coverage

Author: Jeroen Demeyer, André Apitzsch

Reviewer: Volker Braun

Merged: sage-4.8.alpha3

Issue created by migration from https://trac.sagemath.org/ticket/12085

@jdemeyer
Copy link
Contributor Author

comment:1

Attached patch improves the documentation, but unfortunately it does not fix the docbuild warning.

@jdemeyer

This comment has been minimized.

@jdemeyer

This comment has been minimized.

@a-andre
Copy link
Contributor

a-andre commented Nov 26, 2011

comment:3

Have you tried the raw mode? That fixed a similar problem mentioned in #9608.

@jdemeyer
Copy link
Contributor Author

comment:4

Attachment: 12085.patch.gz

Replying to @a-andre:

Have you tried the raw mode? That fixed a similar problem mentioned in #9608.

Fantastic!

@jdemeyer
Copy link
Contributor Author

Changed author from Jeroen Demeyer to Jeroen Demeyer, André Apitzsch

@vbraun
Copy link
Member

vbraun commented Nov 26, 2011

Reviewer: Volker Braun

@vbraun
Copy link
Member

vbraun commented Nov 26, 2011

comment:5

Yep, without raw mode the backslash will wreak havoc...

@jdemeyer
Copy link
Contributor Author

comment:6

Replying to @vbraun:

Yep, without raw mode the backslash will wreak havoc...

True, but I'm still wondering why it works with Python 2.6 but not with Python 2.7.

@kcrisman
Copy link
Member

comment:7

Yep, without raw mode the backslash will wreak havoc...

True, but I'm still wondering why it works with Python 2.6 but not with Python 2.7.

Yeah, that is weird... this is where it shows up, but \f has been one of these for quite a while... because I always have to do \\frac when using labels in plots :)

@jdemeyer
Copy link
Contributor Author

Merged: sage-4.8.alpha3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants