Opened 6 years ago

Closed 6 years ago

#21241 closed defect (fixed)

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

Reported by: Hal Snyder Owned by:
Priority: trivial Milestone: sage-7.4
Component: documentation Keywords: faq-usage faq preparser preparse
Cc: Merged in:
Authors: Frédéric Chapoton Reviewers: Paul Masson
Report Upstream: N/A Work issues:
Branch: 72c48d1 (Commits, GitHub, GitLab) Commit: 72c48d1419de92cc73c25639dc5d11a9b83e46c2
Dependencies: Stopgaps:

Status badges

Description

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()

Change History (10)

comment:1 Changed 6 years ago by Frédéric Chapoton

Authors: Frédéric Chapoton
Branch: public/21241
Commit: 7074a0c262217fd8865b68a8d1e6869b58b10e12
Status: newneeds_review

done, please review.


New commits:

7074a0ctrac 21241 typo in faq (preparser)

comment:2 Changed 6 years ago by Paul Masson

Reviewers: Paul Masson

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.

Last edited 6 years ago by Paul Masson (previous) (diff)

comment:3 Changed 6 years ago by Paul Masson

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?

comment:4 Changed 6 years ago by Paul Masson

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.

comment:5 Changed 6 years ago by Hal Snyder

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.

comment:6 in reply to:  5 Changed 6 years ago by Paul Masson

Replying to hsnyder:

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.

comment:7 Changed 6 years ago by git

Commit: 7074a0c262217fd8865b68a8d1e6869b58b10e1272c48d1419de92cc73c25639dc5d11a9b83e46c2

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

72c48d1trac 21241 details

comment:8 Changed 6 years ago by Frédéric Chapoton

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

comment:9 Changed 6 years ago by Paul Masson

Status: needs_reviewpositive_review

comment:10 Changed 6 years ago by Volker Braun

Branch: public/2124172c48d1419de92cc73c25639dc5d11a9b83e46c2
Resolution: fixed
Status: positive_reviewclosed
Note: See TracTickets for help on using tickets.