Skip to content

[fix, mcast] update mcast public docs formatting#9623

Merged
zeeshanlakhani merged 1 commit into
mainfrom
zl/fix-mcast-fmt-docs
Jan 12, 2026
Merged

[fix, mcast] update mcast public docs formatting#9623
zeeshanlakhani merged 1 commit into
mainfrom
zl/fix-mcast-fmt-docs

Conversation

@zeeshanlakhani

Copy link
Copy Markdown
Collaborator

Simplifies and better formats mcast member joining/leaving docs.

@zeeshanlakhani zeeshanlakhani requested review from ahl and removed request for ahl January 11, 2026 17:57
@zeeshanlakhani

Copy link
Copy Markdown
Collaborator Author

This keeps the newlines, but not the list matter.

// | date-based version should be at the top of the list.
// v
// (next_yyyymmddnn, IDENT),
(2026011100, MULTICAST_JOIN_LEAVE_DOCS),

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.

is a new version required? @sunshowers I thought a trivial change would be ... fine? or is that more of a future? thanks!

@zeeshanlakhani zeeshanlakhani Jan 12, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

From what I can tell, cargo xtask openapi generate doesn't pick up doc changes (even on non-versioned delegation changes), unless the version is bumped. Not sure if there's a way around this using the xtask and our blessed version approach.

@sunshowers sunshowers Jan 12, 2026

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.

Yes, you need to force a version bump in this situation, because we treat blessed versions as immutable. (Either the current or an upcoming dropshot-api-manager will force you to make a bump in this situation.)

BTW RFD 634 was written in part so that people don't feel bad about adding new versions (and seeing a 30k line diff or similar)

@zeeshanlakhani zeeshanlakhani Jan 12, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

BTW RFD 634 was written in part so that people don't feel bad about adding new versions (and seeing a 30k line diff or similar)

Right. Trying not to feel bad (as I've been doing it alot :)).

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.

Thank you. Don't we get paid based on LOC?

@zeeshanlakhani zeeshanlakhani self-assigned this Jan 12, 2026
@zeeshanlakhani

Copy link
Copy Markdown
Collaborator Author

@david-crespo @ahl any other spots in the CLI generation I should fix?

@ahl ahl left a comment

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 great thanks a ton for doing it!

@zeeshanlakhani zeeshanlakhani merged commit 75fe22d into main Jan 12, 2026
16 checks passed
@zeeshanlakhani zeeshanlakhani deleted the zl/fix-mcast-fmt-docs branch January 12, 2026 23:55
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.

4 participants