How do developers use Code Snippets in README files? Analyzing between Python Software Development and Scientific Libraries

README files contain crucial information for clients to effectively use the software.<br> However, we sometimes found that developers either present insufficient content or leave the README files empty.<br> Recent works suggest that, in popular repositories, developers tend to present more code snippets in their README files.<br> In this study, we investigate how developers present code snippets in 10,784 README files of PyPI libraries in terms of (i) the types of code snippets and (ii) the sections where code snippets are presented.<br> Our results indicate the prevalence of types of code snippets in various sections across different types of libraries.

自述文件（README）承载着用户高效使用软件所需的关键信息。
然而，我们时常发现部分开发者要么仅提供了不充分的内容，要么直接将自述文件留空。
现有研究表明，在热门代码仓库中，开发者更倾向于在自述文件中加入更多代码片段（code snippets）。
本研究针对10784个Python包索引（PyPI）库的自述文件展开分析，围绕两大维度探究开发者呈现代码片段的方式：(i) 代码片段的类型；(ii) 代码片段所在的文档章节。
研究结果显示，不同类型的代码片段在各类库的不同文档章节中均具有较高的普及度。