probcomp/bayeslite

typography of bql manual needs work

Open

#74 opened on Jul 2, 2015

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (63 forks)batch import
help wantedmanual

Repository metrics

Stars
 (915 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

  • Fix issues that sphinx warns about.
  • Nix extraneous blank pages.
  • Make the indexes actually exist.
  • Make the py:obj references to list, str, &c., work right.
  • Make references in bayeslite.compiler module description work right.

Contributor guide

Research direction
Review the Sphinx build output for warnings, edit the RST files to fix warnings, remove extraneous blank pages, add missing indexes, and correct cross references.
Tech stack
python
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75