#27176 closed defect (fixed)

fix inaccurate rust docs

Reported by: cyberpunks Owned by:
Priority: Medium Milestone: Tor: 0.3.5.x-final
Component: Core Tor/Tor Version:
Severity: Normal Keywords: rust, doc
Cc: Actual Points:
Parent ID: Points:
Reviewer: teor Sponsor:

Description

Some method descriptions are outdated or were never correct, like the one for parse_protocol_and_version_str().

Child Tickets

Change History (5)

comment:1 Changed 16 months ago by cyberpunks

Patches in branch rust-docs1 at ​​https://gitgud.io/onionk/tor.git

comment:2 Changed 16 months ago by teor

Component: - Select a componentCore Tor/Tor
Milestone: Tor: 0.3.5.x-final
Reviewer: teor
Status: newneeds_revision

Can you explain why you deleted this line?

* If a protocol name cannot be parsed as utf-8.

As far as I'm aware, all rust strings must be utf-8.

comment:3 in reply to:  2 Changed 16 months ago by cyberpunks

Replying to teor:

Can you explain why you deleted this line?

The commit message explains

The function takes an already validated utf-8 string

As far as I'm aware, all rust strings must be utf-8.

Which means this function cannot possibly fail from receiving a non-utf-8 string, because a Rust string is what's being passed in, so it's already been validated when it was created.

The function doesn't do any utf-8 validation.

Last edited 16 months ago by cyberpunks (previous) (diff)

comment:4 Changed 16 months ago by teor

Status: needs_revisionmerge_ready

Thanks for explaining, sorry I missed that.
I'm still getting used to all the different git interfaces.

comment:5 Changed 16 months ago by nickm

Resolution: fixed
Status: merge_readyclosed

Merged!

Note: See TracTickets for help on using tickets.