mostlyright-data 0.19.5__tar.gz → 0.19.6__tar.gz

{mostlyright_data-0.19.5 → mostlyright_data-0.19.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mostlyright-data
-Version: 0.19.5
+Version: 0.19.6
 Summary: Mostly Right hosted CLI for reviewed datasets
 Project-URL: Homepage, https://mostlyright.md/
 Project-URL: Documentation, https://mostlyright.md/docs/guides/cli/

{mostlyright_data-0.19.5 → mostlyright_data-0.19.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mostlyright-data"
-version = "0.19.5"
+version = "0.19.6"
 description = "Mostly Right hosted CLI for reviewed datasets"
 readme = "README.md"
 requires-python = ">=3.13"

{mostlyright_data-0.19.5 → mostlyright_data-0.19.6}/skills/mr-data-build/SKILL.md

@@ -640,16 +640,16 @@ seconds -- not a paragraph, and not a report. Use exactly this shape, in this or
 section out only when there is genuinely nothing to say (shown indented here; the document
 itself carries the headings at column one):
 
-    Two or three plain sentences: what the data is about, why it is worth a look, and what is
-    in it.
+    A plain opening paragraph: what the data contains, what question or model it supports, and
+    the facts a reader needs before using it.
 
     ## Coverage
-    - **Window:** the exact dates and the time zone.
-    - **Grain:** one row per what.
-    - **Cadence:** how often rows arrive, and how many per day or month.
+    - Window: the exact dates and the time zone.
+    - Grain: one row per what.
+    - Cadence: how often rows arrive, and how many per day or month.
 
     ## Columns
-    - `column_name` — what it measures, in which unit.
+    - `column_name`: what it measures, in which unit.
     - (one bullet per column; group unit-sharing columns on one line where that reads better)
 
     ## Missing values
@@ -665,43 +665,33 @@ That is six sections: the opening paragraph, and the five headings under it.
 
 **Opening paragraph** (everything before the first `##` heading)
 
-Two or three short sentences, 120 to 280 characters, written for somebody who has never heard of
-the source, the venue or the format. Sentence one says what the data is about and what makes it
-worth a look, in at most 110 characters. The rest says, in the same plain words, what is in it.
-
-1. No tickers, station codes, series codes, format names, publisher names, row definitions (the
-   sentence that begins `Each row is`) or row counts here. Every one of those facts is in the
-   sections below, which is where a reader who wants it will look.
-2. No Markdown: no bold, no links, no bullets, no code.
-3. A hook is an interesting fact stated plainly, never a pitch. Banned outright: comprehensive,
-   rich, valuable, powerful, unlock, explore, dive into, perfect for, insights, "this dataset", a
-   rhetorical question, an exclamation mark.
-4. Every number in it must be one the run established. "About every half hour" and "thousands of
-   markets" are claims, and a claim that is not on the run does not go here.
-5. The stranger test, before anything else is written: read sentence one alone under the title. If
-   a curious non-specialist could not say what the data is about and would not want the next line,
-   rewrite it.
-6. Plain and short. Every sentence under about twenty words, every sentence a fact: the venue, the
-   subject, the horizon, the cadence, the window. Nothing about what a reader might do with it: no
-   "so you can", "a way to", "ready to", "for seeing". Say what is there and stop.
-
-One airport weather table, the shape to avoid and the shape to write. To avoid:
-
-    Each row is one METAR or SPECI weather report from Beijing (ZBAA), since January 2020, via
-    Iowa Environmental Mesonet. 117,876 reports of temperature, wind, pressure, visibility with
-    the day's highest and lowest reading.
-
-To write:
-
-    Beijing airport weather since 2020, a report about every half hour, with the day's high and
-    low on each row. Temperature, wind, pressure and visibility as the airport recorded them.
-
-The station code, the report types, the publisher and the count all moved down to Coverage and to
-Source and rights, where a reader who wants them looks. "About every half hour" stays only because
-Coverage puts a month at 1,302 to 1,591 rows, which is one row every 27 to 33 minutes. Three ways
-to fail: the pitch (`Unlock real-time insights into how prediction markets price
-the weather!`), the promise (`ready to test a forecast against what actually happened`) and the
-bare subject with no reason to care (`Beijing weather data.`).
+Write as an engineer explaining a useful table to another engineer. The opening may have more than
+two sentences. Start with the concrete records the dataset contains. Then say which question the
+records help answer or which model they can support. Include geography, time range, row grain,
+update cadence and material limitations when those facts are known. Put a join, transformation or
+source caveat here only when it changes how somebody should use the data.
+
+1. The first two sentences must distinguish this dataset from every other dataset in the set. If
+   both sentences could describe another dataset unchanged, rewrite them.
+2. Use ordinary verbs such as contains, tracks, joins, updates, records and returns. Vary sentence
+   length, and use short sentences for the important facts.
+3. Preserve every established fact. Never invent coverage, freshness, quality, licensing or an
+   intended use.
+4. Write `Mostly Right`, with a space, except inside a literal identifier that uses another form.
+5. Use no Markdown in the opening paragraph. Do not use generic openings such as `This dataset
+   provides`, marketing claims such as `comprehensive`, `powerful` or `high-quality`, or abstract
+   phrases such as `enables insights`, `facilitates analysis` or `serves as a valuable resource`.
+6. Do not explain page design or metadata fields. Do not use em dashes, semicolons, bold labels or
+   fake quotations. Explain the data before implementation details.
+
+After the build establishes each fact, an airport-weather opening can read:
+
+    Hourly weather observations from 20 airport stations across the United States. Each row records
+    one station report with temperature, dew point, wind, visibility, and observation time. Use it
+    to compare observed conditions across stations and time or train a short-term weather model.
+    The table keeps multiple reports within an hour when conditions change, so aggregate it before
+    using one row per station-hour. Mostly Right refreshes the recent window and preserves older
+    observations.
 
 **Body rules** (the five sections under the headings)
 1. Every sentence must stay true and complete when quoted alone, away from the page. Never
@@ -715,21 +705,26 @@ bare subject with no reason to care (`Beijing weather data.`).
 5. Everything in the paragraph below still applies.
 
 Rules that keep it readable: short sentences; no sentence over about twenty-five words; bullets
-rather than comma lists; no tables, no code blocks, no links to internal tools, no headings beyond
+rather than comma lists; no bold labels, em dashes, semicolons or fake quotations; no tables, no
+code blocks, no links to internal tools, no headings beyond
 the ones above. Spell out the names a reader would search for -- the place, the identifiers in
 every common form, the programme and the publisher -- once each, under Coverage and under
 Source and rights, and never as a keyword list. A one-line description is a defect to fix in the
 revision, not a style choice. Give `table.description` the grain and the window.
+Every statement in the opening and body must preserve an established fact. Never add unsupported
+coverage, freshness, quality, licensing or intended use.
 
 **Check before writing.** Fix and re-check until every line passes:
 - title: at most 60 characters, contains the place, contains no colon, pipe or exclamation mark,
   no brand, no "dataset" or "data", no version number, no run date
-- opening paragraph: two or three sentences, each under about twenty words, 120 to 280 characters,
-  first full stop before character 110, no Markdown, no identifier, publisher name, row count or
-  row definition, no banned word, no clause about what a reader might do
+- opening paragraph: at least two distinct sentences, with the concrete records first and the
+  question or model they support next; include known geography, time range, grain, update cadence
+  and material limitations; no Markdown, banned style or invented fact
 - category: exactly one fixed ID saved and verified before recipe registration
 - topics: 3 to 8 descriptive tags, no duplicates, lowercase, at most 40 characters each
 - licence: an SPDX identifier the sources actually grant, or `--license` left off
+- whole description: every statement preserves an established fact; no bold labels, em dashes,
+  semicolons, fake quotations or unsupported claims
 - every `##` heading in DESCRIPTION.md is one of the five, in that relative order, none repeated
 
 **Every dataset gets a cover before its first run is presented.** Once the description is