https://github.com/luxedo/exemplar

Write Once, Explain Clearly: Powerful Doctests Examples for Everyone
https://github.com/luxedo/exemplar

doctest examples pytest python

Last synced: 8 months ago
JSON representation

Write Once, Explain Clearly: Powerful Doctests Examples for Everyone

• Host: GitHub
• URL: https://github.com/luxedo/exemplar
• Owner: luxedo
• License: mit
• Created: 2024-06-17T18:31:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-17T18:52:27.000Z (over 1 year ago)
• Last Synced: 2024-12-30T17:49:21.827Z (10 months ago)
• Topics: doctest, examples, pytest, python
• Homepage:
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Exemplar

> Write Once, Explain Clearly: Powerful Doctests Examples for Everyone

> 

> ⚠️ This project is currently in its initial stages. We welcome contributions and collaboration from the Python community!

## Overview

Exemplar is a Python project aiming to standardize and improve the creation of code examples within documentation, particularly focusing on doctests. Our goal is to make code documentation clearer, more user-friendly, and ultimately empower developers of all experience levels.

## Motivation

High-quality examples are crucial for understanding code libraries and their functionalities. However, documentation examples can often be inconsistent, incomplete, or lack clarity. This can be a barrier to entry for newcomers and a source of frustration for experienced developers.

Some benefits of good examples include:

* **Reduced Learning Curve:** Clear and well-documented examples lower the barrier to entry for new users of Python libraries.

* **Improved Retention:** Users gain a deeper understanding of code functionality through practical examples.

* **Enhanced Collaboration:** Consistent and well-documented examples facilitate better collaboration among developers.

* **Streamlined Development:** Standardized example creation saves time and effort for developers.

## Exemplar's Approach

* **Standardization:** Define best practices for creating clear, informative, and well-structured code examples within documentation.

* **Doctest Integration:** Leverage doctests to seamlessly integrate executable examples within documentation, ensuring their accuracy and relevance.

* **Measurable Quality:** Develop metrics and tools to evaluate the comprehensiveness and clarity of code examples.

* **Broader Applicability:** While initially focusing on NumPy, the project aims to create a framework applicable to various Python libraries.