Published April 28, 2023 | Version v1

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

Authors/Creators

  • 1. Nara Institute of Science and Technology

Description

README files contain crucial information for clients to effectively use the software.
However, we sometimes found that developers either present insufficient content or leave the README files empty.
Recent works suggest that, in popular repositories, developers tend to present more code snippets in their README files.
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.
Our results indicate the prevalence of types of code snippets in various sections across different types of libraries.

Files

Zenodo.zip

Files (97.9 MB)

Name Size Download all
md5:4b48de30834092ef86240f26d12b212c
97.9 MB Preview Download