rust-lang / rust-lang/rust-by-example
Switch from RAII to OBRM terminology
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
Same as in https://github.com/rust-unofficial/patterns/issues/322, as I found out in a discussion, a lot of the documentation - even this official one - still primarily or even exclusively uses RAII terminology for that feature.
AFAIK OBRM is the official term, and based on my own experience and others feedback it's a lot more intuitive.
As referenced in the linked PR I don't want to remove RAII references, just switch to primarily using OBRM terminology, and as with that issue I'll hopefully get to making a PR on this over the weekend, but others can feel free to to it themselves before that. And of course here too I'd first like to know that such a PR would actually be appreciated.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the repository's documentation for uses of RAII terminology and compare the requested scope with the linked patterns issue. Update relevant wording to use OBRM primarily while retaining RAII references, then verify that the affected documentation consistently reflects both terms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100