Skip to content

docs: Discourage into(), try_into() and parse() #8180

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.

Sign up for GitHub

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

Merged
Hocuri merged 3 commits into from
Apr 30, 2026
+13 −0
Merged

docs: Discourage into(), try_into() and parse() #8180

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cf56527
docs: Discourage `into()`, `try_into()` and `parse()`
Hocuri Apr 27, 2026
44ee92f
Note JsonRPC API
Hocuri Apr 27, 2026
e254aeb
Drop last paragraph
Hocuri Apr 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions STYLE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,16 @@ are documented.

Follow Rust guidelines for the documentation comments:
<https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#summary-sentence>

## Do not use `into()`, `try_into()` or `parse()`

For internal types, implementing `From`, `TryFrom` or `FromStr` is discouraged.
Instead, a `new()` function is recommended.

For external types, prefer using `Type::from()`, `Type::try_from()` or `Type::from_str()`
over `into()`, `try_into()` or `parse()`.

Calling `into()`, `try_into()` or `parse()`
creates an indirection,
which is hard to follow for people who are not familiar with Rust,
or who are not using rust-analyzer.