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

faq-usage typo 'preparse' should be 'preparser' #21241

Closed
DrXyzzy opened this issue Aug 13, 2016 · 14 comments
Closed

faq-usage typo 'preparse' should be 'preparser' #21241

DrXyzzy opened this issue Aug 13, 2016 · 14 comments

Comments

@DrXyzzy
Copy link

DrXyzzy commented Aug 13, 2016

In src/doc/en/faq/faq-usage.rst around line 362, text says

You can also disable the preprocessor in your code via
 ``preparse(False)``.

This should read

You can also disable the preprocessor in your code via
 ``preparser(False)``.

Example: try the following in sage command line session. It fails with an exception.

num = 123
num.bit_length()

But this succeeds and produces output:

preparser(False)
num = 123
num.bit_length()

Component: documentation

Keywords: faq-usage faq preparser preparse

Author: Frédéric Chapoton

Branch/Commit: 72c48d1

Reviewer: Paul Masson

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

@DrXyzzy DrXyzzy added this to the sage-7.4 milestone Aug 13, 2016
@fchapoton
Copy link
Contributor

comment:1

done, please review.


New commits:

7074a0ctrac 21241 typo in faq (preparser)

@fchapoton
Copy link
Contributor

Author: Frédéric Chapoton

@fchapoton
Copy link
Contributor

Commit: 7074a0c

@fchapoton
Copy link
Contributor

Branch: public/21241

@paulmasson
Copy link
Mannequin

paulmasson mannequin commented Aug 13, 2016

Reviewer: Paul Masson

@paulmasson
Copy link
Mannequin

paulmasson mannequin commented Aug 13, 2016

comment:2

In the next sentence please change "can may" to "can" and ". Or switching" to " or switch" for correct grammar.

There are two other instances of "preparse(" in this file on L286 and L333 which are correct. Please correct those as well.

@paulmasson
Copy link
Mannequin

paulmasson mannequin commented Aug 13, 2016

comment:3

Also, preparse is no longer located in sage.all as stated on L301. It's now in sage.repl.all. Shouldn't that also be corrected?

@paulmasson
Copy link
Mannequin

paulmasson mannequin commented Aug 13, 2016

comment:4

Please also let me know for future reference whether it's simpler for me to make changes like this on a public branch and then have you review them. Happy to do so if that's a better work flow.

@DrXyzzy
Copy link
Author

DrXyzzy commented Aug 13, 2016

comment:5

References to "preparse(): at L286 and L333 are correct. There are two similarly-named functions. First parameter to preparse() is a line of code. Parameter to preparser() is a boolean.

@paulmasson
Copy link
Mannequin

paulmasson mannequin commented Aug 13, 2016

comment:6

Replying to @DrXyzzy:

References to "preparse(): at L286 and L333 are correct. There are two similarly-named functions. First parameter to preparse() is a line of code. Parameter to preparser() is a boolean.

Right you are. Sorry for the confusion. Will update previous comment.

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 14, 2016

Changed commit from 7074a0c to 72c48d1

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Aug 14, 2016

Branch pushed to git repo; I updated commit sha1. New commits:

72c48d1trac 21241 details

@fchapoton
Copy link
Contributor

comment:8

done. The import of line 301 still works, so does not need to be changed.

@vbraun
Copy link
Member

vbraun commented Aug 17, 2016

Changed branch from public/21241 to 72c48d1

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

3 participants