mac module documentation inaccuracy.

[mrmiller]

BPO	505150
Nosy	@freddrake, @jackjansen
Files	libmac.tex.diff

^{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 = 'https://github.com/freddrake'
closed_at = <Date 2002-10-24.20:31:33.000>
created_at = <Date 2002-01-17.23:10:01.000>
labels = ['docs']
title = 'mac module documentation inaccuracy.'
updated_at = <Date 2002-10-24.20:31:33.000>
user = 'https://bugs.python.org/mrmiller'

bugs.python.org fields:

activity = <Date 2002-10-24.20:31:33.000>
actor = 'fdrake'
assignee = 'fdrake'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2002-01-17.23:10:01.000>
creator = 'mrmiller'
dependencies = []
files = ['296']
hgrepos = []
issue_num = 505150
keywords = []
message_count = 5.0
messages = ['8827', '8828', '8829', '8830', '8831']
nosy_count = 3.0
nosy_names = ['fdrake', 'jackjansen', 'mrmiller']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue505150'
versions = ['Python 2.2']

[mrmiller]

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.

[jackjansen]

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

[freddrake]

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.

[jackjansen]

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".

[freddrake]

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.