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.
Write our own summaries of std types' API surface · google/comprehensive-rust#2248 | Good First Issue