{"id":18853135,"url":"https://github.com/luxedo/exemplar","last_synced_at":"2026-02-04T20:30:15.460Z","repository":{"id":244844343,"uuid":"816431591","full_name":"luxedo/exemplar","owner":"luxedo","description":"Write Once, Explain Clearly: Powerful Doctests Examples for Everyone","archived":false,"fork":false,"pushed_at":"2024-06-17T18:52:27.000Z","size":3,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-30T17:49:21.827Z","etag":null,"topics":["doctest","examples","pytest","python"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/luxedo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-17T18:31:17.000Z","updated_at":"2024-12-18T23:21:15.000Z","dependencies_parsed_at":"2024-06-17T21:01:37.253Z","dependency_job_id":null,"html_url":"https://github.com/luxedo/exemplar","commit_stats":null,"previous_names":["luxedo/exemplar"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luxedo%2Fexemplar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luxedo%2Fexemplar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luxedo%2Fexemplar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luxedo%2Fexemplar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luxedo","download_url":"https://codeload.github.com/luxedo/exemplar/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239793056,"owners_count":19697893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["doctest","examples","pytest","python"],"created_at":"2024-11-08T03:43:03.528Z","updated_at":"2026-02-04T20:30:15.403Z","avatar_url":"https://github.com/luxedo.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Exemplar\n\u003e Write Once, Explain Clearly: Powerful Doctests Examples for Everyone\n\u003e \n\u003e ⚠️ This project is currently in its initial stages. We welcome contributions and collaboration from the Python community!\n\n## Overview\n\nExemplar 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.\n\n## Motivation\n\nHigh-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.\n\nSome benefits of good examples include:\n* **Reduced Learning Curve:** Clear and well-documented examples lower the barrier to entry for new users of Python libraries.\n* **Improved Retention:** Users gain a deeper understanding of code functionality through practical examples.\n* **Enhanced Collaboration:** Consistent and well-documented examples facilitate better collaboration among developers.\n* **Streamlined Development:** Standardized example creation saves time and effort for developers.\n\n## Exemplar's Approach\n* **Standardization:** Define best practices for creating clear, informative, and well-structured code examples within documentation.\n* **Doctest Integration:** Leverage doctests to seamlessly integrate executable examples within documentation, ensuring their accuracy and relevance.\n* **Measurable Quality:** Develop metrics and tools to evaluate the comprehensiveness and clarity of code examples.\n* **Broader Applicability:** While initially focusing on NumPy, the project aims to create a framework applicable to various Python libraries.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluxedo%2Fexemplar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluxedo%2Fexemplar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluxedo%2Fexemplar/lists"}