This repository has been archived by the owner on Mar 16, 2024. It is now read-only.
Extend and format docstrings throughout the codebase #56
Labels
help wanted
Extra attention is needed
Title: Enhancing Docstring Quality through LLM Integration and Formatting
Issue Description:
Our project's documentation is a unique hybrid of human contributions and content generated by our Language Model (LLM). The structure comprises three layers:
L3 documentation aids coding by being available alongside the source code. This layer presents a potential opportunity for improvement - we could utilize it to enrich our L1 docstrings, thereby enhancing the initial human-created documentation.
The purpose of this task is to create a mechanism to "bubble up" information from L3 back to L1. This means that we will take the enhanced documentation of L3, refine it, and integrate it into the L1 docstrings. By doing so, we can provide coders with more comprehensive and insightful documentation to follow.
Furthermore, this integration allows for recursive improvement over iterations. If the LLM pipeline is run a second time, it would start with the enriched docstrings from the first run, thus progressively amplifying the quality and richness of the documentation.
Let's take the Tensorflow library as an example to visualize the level of comprehensive docstrings we aim to achieve:
This task, therefore, is not just about enhancing the quality of our documentation but also about creating a novel and innovative approach to docstring creation and maintenance. By using a recursive model of improvement, we can leverage the strengths of both human input and machine learning models to deliver highly effective and continuously improving documentation. This blend of human intuition and machine efficiency has the potential to revolutionize the way we think about and generate documentation in the coding process.
Feel free to post any questions or concerns you have about this implementation. Your contribution to this project is highly appreciated!
The text was updated successfully, but these errors were encountered: