leostera / leostera/rules_reason

Add odoc rules

Open
#6 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Python
Stars
19
Forks
1
PR merge metrics
No merged PRs in 30d

Description

ocaml_module(
  name = "module_srcs",
  srcs = glob(["*.ml", "*.mli"]),
)

odoc_unit(
  name = "docs.odoc",
  srcs = [ ":module_srcs" ],
)

odoc_html(
  name = "docs.html",
  srcs = [ ":docs.odoc"]
)

Alternatively

ocaml_module(
  name = "module_srcs",
  srcs = glob(["*.ml", "*.mli"]),
)

odoc(
 name = "docs",
 srcs = [ ":module_srcs" ],
)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests, so first locate the repository's existing OCaml and Bazel rule entry points and follow their conventions. Compare the available rule interfaces with the issue's odoc, odoc_html, and combined odoc examples; the work is done when those examples are supported and covered by the repository's relevant checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
ocaml
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.