google/comprehensive-rust

Write our own summaries of std types' API surface

Open

#2,248 建立於 2024年7月23日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Rust (32,954 star) (2,009 fork)batch import
good first issue

描述

Currently our section on std library types consists of a slide for each type with an example, and when teaching this is nice as an intro but gets followed up by a dive into the API docs at https://std.rs/ to cover more comprehensively all the API surface that students should know.

We focus on:

  • shared API method and patterns that are not captured by traits
  • novel APIs around ownership and borrowing (like into_boxed_slice, leak, and split_at_mut)
  • interesting string APIs around the Pattern trait and UTF-8
  • slice APIs for sorting and partitioning
  • methods inherited via Deref impls
  • the HashMap Entry API

But there's a lot that we have to scroll past and ignore because it's boring, rarely useful, unstable, etc..

It would be nice to have our own summaries of these APIs that present things with emphasis on what we care about and skip the stuff that doesn't matter for teaching.

I don't think these will likely fit into small slides, so maybe someone with opinions on slide heights/scrolling should opine here.

貢獻者指南

技術棧
rust
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Rust knowledgeStandard library familiarityCourse contextWriting documentation
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
The issue asks to create summaries of std types' API surface focusing on shared methods, ownership patterns, string/slice APIs, and HashMap Entry. Review existing slides under src/ to understand the current layout. Consult the standard library docs at https://std.rs/ to select relevant methods. The summaries should skip rarely useful details and consider slide height constraints as mentioned by the maintainer.