Skip to content

Format markdown#555

Open
cthoyt wants to merge 2 commits into
masterfrom
format-markdown
Open

Format markdown#555
cthoyt wants to merge 2 commits into
masterfrom
format-markdown

Conversation

@cthoyt
Copy link
Copy Markdown
Member

@cthoyt cthoyt commented May 28, 2026

This PR runs npx prettier --check --prose-wrap always --write **/*.md to format all markdown in the repo. It doesn't change any content (except one minor typo and one section where I converted italics at the beginning of paragraphs into proper headers)

This PR does not add any linting checks to CI (yet, maybe in a follow-up)

There are many times I wanted to do typo checks/editing/revising but wasn't able to because the diff would have been too big because of using single lines. This enables me to more effectively edit and revise

@cthoyt cthoyt requested review from gouttegd and matentzn and removed request for gouttegd May 28, 2026 14:07
Comment thread src/docs/spec-support-hashing.md Outdated
2. Sort the list of values in lexicographical order and iterate over the
sorted values. For each value _V_, append `N:V`, where _N_ is the
length of _V_.
3. Append `)`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is incorrect. There is a reason for this additional space in front of those numbers: it’s to indicate that we are dealing with “sub-sub-items” (a list within a list within a list).

This is what allows the (correct) existing rendering:

Image

This change completely messes up the rendering:

Image

Comment thread src/docs/spec-support-hashing.md Outdated
extension and _N_ is the length of the property.
2. Use the table below to transform the extension value into a string _V_
based on the declared type of the extension.
3. Append `N:V)`, where _N_ is the length of the string value _V_.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

Correct rendering (before the change):

Image

Wrong rendering (after this change):

Image

2. Iterate over all slots of the `Mapping` class, in the order in which they are
[listed](../Mapping/#slots) in the LinkML model. Exclude the `record_id` slot
and the `mapping_cardinality` slot. For all other slots:
1. If the slot has no value for the mapping record to hash, skip to next
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still incorrect. Here is the rendering:

Image

This time it’s the sub-items that are not recognised as such.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants