Help us shape the future of Go! Take the 2026 Go Developer Survey

mdreport

package
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2026 License: BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Overview

Package mdreport writes a generated Markdown report while preserving the hand-written analysis a previous run left below a marker line.

The convention is go-webengine/engine's, from its bench REPORT.md, and html2pdf's corpus harnesses carried it; it comes here with judges because a table nobody wrote under is a table nobody read. Whatever a reader wrote beneath the marker — which cell was judge noise, which one was a defect and where it was fixed — survives the next run, and a re-run never clobbers it.

Index

Constants

View Source
const Marker = "<!-- BEGIN ANALYSIS -->"

Marker separates the regenerated part of a report (above) from the preserved, hand-written analysis (below).

View Source
const Placeholder = Marker + "\n\n_Analysis pending — see the table above and out/ for a first look._\n"

Placeholder is written below the marker on a first run, when there is no analysis to preserve yet.

Variables

This section is empty.

Functions

func Write

func Write(path, generated string) error

Write replaces path's content above Marker with generated (which must not itself contain the marker) and keeps everything from the marker on, or writes Placeholder there when the file did not exist or had no marker.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL