This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: mac module documentation inaccuracy.
Type: Stage:
Components: Documentation Versions: Python 2.2
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, jackjansen, mrmiller
Priority: normal Keywords:

Created on 2002-01-17 23:10 by mrmiller, last changed 2022-04-10 16:04 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
libmac.tex.diff jackjansen, 2002-02-05 22:22
Messages (5)
msg8827 - (view) Author: Martin Miller (mrmiller) Date: 2002-01-17 23:10
The documentation at <http://www.python.org/doc/current/mac/module-mac.html> for the
MacPython 2.2 mac module says, in part:

> ==snip==
>> One additional function is available:
>>
>> xstat(path)
>>        This function returns the same information as stat(), 
>> but with three additional values appended: the size of the 
>> resource fork of the file and its
>>        4-character creator and type.
> ==snip==

The xstat() function is available only under PPC MacPython but not under Carbon MacPython.
The documentation should be updated, assuming the ommision was intentional. Ideally, it would 
suggest alternatives for the Carbon version.
msg8828 - (view) Author: Jack Jansen (jackjansen) * (Python committer) Date: 2002-02-05 22:22
Logged In: YES 
user_id=45365

Here is a patch for libmac.tex. I'll leave it to you to replace the \code{} sections with one of the gazillion macros I can never remember, hope you don't mind:-)
msg8829 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2002-02-14 16:49
Logged In: YES 
user_id=3066

Jack -- the FSSpec object as documented allows access to the
creator and type information, but not the size of the
resource fork.  How should the caller get that?

Thanks.
msg8830 - (view) Author: Jack Jansen (jackjansen) * (Python committer) Date: 2002-02-15 10:08
Logged In: YES 
user_id=45365

You can't. After some discussion on the SIG this was deemed to not be important enough to stop us getting rid of xstat(), nobody on the list ever used the resource size. But you're right, it probably needs a note in the docs. Maybe add a line "This does not give you the resource fork size, but that information is of limited interest anyway".
msg8831 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2002-10-24 20:31
Logged In: YES 
user_id=3066

Not sure why this is still open; it looks like the docs
already have all the relevant updates.  Closing the report.
History
Date User Action Args
2022-04-10 16:04:53adminsetgithub: 35938
2002-01-17 23:10:01mrmillercreate