Wait, wasn't that code here before? Detecting Outdated Software Documentation

• URL: http://arxiv.org/abs/2307.04291v1
• Date: Mon, 10 Jul 2023 00:52:29 GMT
• Title: Wait, wasn't that code here before? Detecting Outdated Software Documentation
• Authors: Wen Siang Tan, Markus Wagner, Christoph Treude
• Abstract summary: We present a GitHub Actions tool that automatically scans for outdated code element references. More than a quarter of the 1000 most popular projects on GitHub contained at least one outdated reference.
• Score: 9.45052138795667
• License: http://arxiv.org/licenses/nonexclusive-distrib/1.0/
• Abstract: Encountering outdated documentation is not a rare occurrence for developers and users in the software engineering community. To ensure that software documentation is up-to-date, developers often have to manually check whether the documentation needs to be updated whenever changes are made to the source code. In our previous work, we proposed an approach to automatically detect outdated code element references in software repositories and found that more than a quarter of the 1000 most popular projects on GitHub contained at least one outdated reference. In this paper, we present a GitHub Actions tool that builds on our previous work's approach that GitHub developers can configure to automatically scan for outdated code element references in their GitHub project's documentation whenever a pull request is submitted.

Related papers

• Linking Code and Documentation Churn: Preliminary Analysis [2.033674689332928]
  This study investigates the synchrony between code churn and documentation updates in three GitHub open-source projects. Preliminary results indicate varying degrees of synchrony across projects, highlighting the importance of integrated concurrent documentation practices. The novelty of this study lies in demonstrating how synchronizing code changes with documentation updates can improve the development lifecycle by enhancing diversity and efficiency.
  arXiv  Detail & Related papers  (2024-10-08T12:41:58Z)
• RepoAgent: An LLM-Powered Open-Source Framework for Repository-level Code Documentation Generation [79.83270415843857]
  We introduce RepoAgent, a large language model powered open-source framework aimed at proactively generating, maintaining, and updating code documentation. We have validated the effectiveness of our approach, showing that RepoAgent excels in generating high-quality repository-level documentation.
  arXiv  Detail & Related papers  (2024-02-26T15:39:52Z)
• How do Software Engineering Researchers Use GitHub? An Empirical Study of Artifacts & Impact [0.2209921757303168]
  We ask whether and how authors engage in social coding related to their research. Ten thousand papers in top SE research venues, hand-annotating their GitHub links, and studying 309 paper-related repositories. We find a wide distribution in popularity and impact, some strongly correlated with publication venue.
  arXiv  Detail & Related papers  (2023-10-02T18:56:33Z)
• Coeditor: Leveraging Contextual Changes for Multi-round Code Auto-editing [57.776971051512234]
  In this work, we explore a multi-round code auto-editing setting, aiming to predict edits to a code region based on recent changes within the same. Our model, Coeditor, is a fine-tuned language model specifically designed for code editing tasks. In a simplified single-round, single-edit task, Coeditor significantly outperforms GPT-3.5 and SOTA open-source code completion models.
  arXiv  Detail & Related papers  (2023-05-29T19:57:36Z)
• RepoCoder: Repository-Level Code Completion Through Iterative Retrieval and Generation [96.75695811963242]
  RepoCoder is a framework to streamline the repository-level code completion process. It incorporates a similarity-based retriever and a pre-trained code language model. It consistently outperforms the vanilla retrieval-augmented code completion approach.
  arXiv  Detail & Related papers  (2023-03-22T13:54:46Z)
• DocCoder: Generating Code by Retrieving and Reading Docs [87.88474546826913]
  We introduce DocCoder, an approach that explicitly leverages code manuals and documentation. Our approach is general, can be applied to any programming language, and is agnostic to the underlying neural model.
  arXiv  Detail & Related papers  (2022-07-13T06:47:51Z)
• GitHub Actions: The Impact on the Pull Request Process [7.047566396769727]
  This study investigates how projects use GitHub Actions, what the developers discuss about them, and how project activity indicators change after their adoption. Our results indicate that 1,489 out of 5,000 most popular repositories (almost 30% of our sample) adopt GitHub Actions. Our findings also suggest that the adoption of GitHub Actions leads to more rejections of pull requests (PRs), more communication in accepted PRs and less communication in rejected PRs.
  arXiv  Detail & Related papers  (2022-06-28T16:24:17Z)
• Repro: An Open-Source Library for Improving the Reproducibility and Usability of Publicly Available Research Code [74.28810048824519]
  Repro is an open-source library which aims at improving the usability of research code. It provides a lightweight Python API for running software released by researchers within Docker containers.
  arXiv  Detail & Related papers  (2022-04-29T01:54:54Z)
• InCoder: A Generative Model for Code Infilling and Synthesis [88.46061996766348]
  We introduce InCoder, a unified generative model that can perform program synthesis (via left-to-right generation) and editing (via infilling) InCoder is trained to generate code files from a large corpus of permissively licensed code. Our model is the first generative model that is able to directly perform zero-shot code infilling.
  arXiv  Detail & Related papers  (2022-04-12T16:25:26Z)
• Predicting Issue Types on GitHub [8.791809365994682]
  Ticket Tagger is a GitHub app analyzing the issue title and description through machine learning techniques. We empirically evaluated the tool's prediction performance on about 30,000 GitHub issues.
  arXiv  Detail & Related papers  (2021-07-21T08:14:48Z)
• The penumbra of open source: projects outside of centralized platforms are longer maintained, more academic and more collaborative [0.0]
  We develop a novel, extensive sample of public open source project repositories outside of centralized platforms. Our sample projects tend to have more collaborators, are maintained for longer periods, and tend to be more focused on academic and scientific problems.
  arXiv  Detail & Related papers  (2021-06-29T17:54:26Z)

This list is automatically generated from the titles and abstracts of the papers in this site.

This site does not guarantee the quality of this site (including all information) and is not responsible for any consequences.