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

doctest and exception messages #37618

Closed
aahz mannequin opened this issue Dec 16, 2002 · 8 comments
Closed

doctest and exception messages #37618

aahz mannequin opened this issue Dec 16, 2002 · 8 comments
Labels
docs Documentation in the Doc dir

Comments

@aahz
Copy link
Mannequin

aahz mannequin commented Dec 16, 2002

BPO 654783
Nosy @tim-one, @freddrake, @nascheme, @facundobatista

Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2005-05-30.20:05:35.000>
created_at = <Date 2002-12-16.19:23:49.000>
labels = ['docs']
title = 'doctest and exception messages'
updated_at = <Date 2005-05-30.20:05:35.000>
user = 'https://bugs.python.org/aahz'

bugs.python.org fields:

activity = <Date 2005-05-30.20:05:35.000>
actor = 'facundobatista'
assignee = 'aahz'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-12-16.19:23:49.000>
creator = 'aahz'
dependencies = []
files = []
hgrepos = []
issue_num = 654783
keywords = []
message_count = 8.0
messages = ['13629', '13630', '13631', '13632', '13633', '13634', '13635', '13636']
nosy_count = 5.0
nosy_names = ['tim.peters', 'fdrake', 'nascheme', 'facundobatista', 'aahz']
pr_nums = []
priority = 'normal'
resolution = 'wont fix'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue654783'
versions = ['Python 2.2']

@aahz
Copy link
Mannequin Author

aahz mannequin commented Dec 16, 2002

doctest should include information something like this:

doctest docstrings should not rely on the text of internal Python
exceptions.  Notice the way factorial() uses its own error messages
with the standard Python exceptions.  The internal messages can
change even in bugfix releases (as in 2.2.1 to 2.2.2).

@aahz aahz mannequin closed this as completed Dec 16, 2002
@aahz aahz mannequin self-assigned this Dec 16, 2002
@aahz aahz mannequin added docs Documentation in the Doc dir labels Dec 16, 2002
@nascheme
Copy link
Member

Logged In: YES
user_id=35752

Couldn't doctest be modified so that it only compares the
exception
name only?

@tim-one
Copy link
Member

tim-one commented Dec 16, 2002

Logged In: YES
user_id=31435

It could, but it shouldn't: error msgs in docs that don't match
reality are also an insult to users. doctest should grow some
sort of option here, though, as its uses outgrew its original
purposes.

@tim-one
Copy link
Member

tim-one commented Apr 25, 2003

Logged In: YES
user_id=31435

Back to Aahz. I don't mind if you change this -- edit the docs
and check it in.

@freddrake
Copy link
Member

Logged In: YES
user_id=3066

Tim sent this back to Aahz, so I'm assigning it to him as a
reminder.
;-)

@facundobatista
Copy link
Member

Logged In: YES
user_id=752496

Please, could you verify if this problem persists in Python 2.3.4
or 2.4?

If yes, in which version? Can you provide a test case?

If the problem is solved, from which version?

Note that if you fail to answer in one month, I'll close this bug
as "Won't fix".

Thank you!

. Facundo

@facundobatista
Copy link
Member

Logged In: YES
user_id=752496

What should change Aahz in the docs? Not clear to me...

@facundobatista
Copy link
Member

Logged In: YES
user_id=752496

Deprecated. Reopen only if still happens in 2.3 or newer.

. Facundo

@ezio-melotti ezio-melotti transferred this issue from another repository Apr 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

4 participants