probcomp/bayeslite

BQL and MML documentation is out of date

Open

#502 opened on Nov 29, 2016

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (915 stars) (63 forks)batch import
blockedhelp wantedmanual

Description

The documentation for BQL and MML was last updated about 6 months ago and might not reflect the latest implementation.

Contributor guide

Tech stack
pythonsqlite
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Python basicsFamiliarity with BQL and MML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review existing documentation for BQL and MML in the repository's docs/ directory or inline comments. Compare with the latest source code to identify outdated statements. Update the documentation to accurately reflect current behavior, and consider adding examples or clarifications.