Repository navigation
docs: README, DocC catalogues, licence texts and CITATION for 0.11.0 - #26
Merged
Merged
Conversation
README: install line at 0.11.0 with the repository URL, readers and writers (writers ship), CI/docs/release/licence badges and the docs link, one sentence that the shipped binaries are arm64 only, no private design-note remark, no names.sh in the build list. DocC: FormatoMRC's catalogue described a module with no API; it now documents MRCReader, MRCAppImage and MRCError. New catalogues for Formato, FormatoPeek and FormatoMIB, so every product has one; .spi.yml lists all eleven. Licenses/ gains the tifffile 2026.9.20 and Pint 0.26.1 BSD-3-Clause texts, both ported from; NOTICE points at them. CITATION.cff gains version and date-released and loses the ORCID TODO. The CHANGELOG format and the single SPDX id wait for the release-please and licence decisions (triage 28 Oct). Refs #14 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VkKZEVqoFybEsYt19gka8C
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Paul · project thread
Refs #14 (the parts the 28 Oct triage cleared to go first; the issue stays open for the rest).
What changed
.package(url: "https://github.com/mac4DSTEM/FormatoKit.git", from: "0.11.0"); "readers and writers" (writers ship); CI, Docs, release and licence badges plus the DocC site link; one sentence that the shipped binaries are arm64 only; the "design note archived in the suite's private folder" remark is gone;names.shis no longer in the build list.FormatoMRC.doccsaid "no public API yet"; it now documentsMRCReader,MRCAppImage,MRCError, and its Scope article says what is read and pinned. New catalogues forFormato,FormatoPeekandFormatoMIB, so every product has one.MRCReadergets the doc comment it lacked..spi.ymllists all eleven modules (MSA is no longer called an empty placeholder).tifffile-LICENSE.txt(tifffile v2026.9.20) andPint-LICENSE.txt(Pint 0.26.1), verbatim from the upstream tags; NOTICE points at them and loses its private-folder sentence.version: "0.11.0",date-released: "2026-10-22", the ORCID TODO removed.Waiting, per the triage comment
versionis updated by hand at each tag until release-please can bump it.The docs workflow runs on this PR, since it touches
.doccfiles, and builds the three new catalogues. Written on Linux, so macOS CI is the build check.Generated by Claude Code