Skip to content

Touchup some docs#212

Merged
evantypanski merged 2 commits intomasterfrom
topic/etyp/minor-docs-fixes
Sep 16, 2025
Merged

Touchup some docs#212
evantypanski merged 2 commits intomasterfrom
topic/etyp/minor-docs-fixes

Conversation

@evantypanski
Copy link
Copy Markdown
Member

I was looking at the zkg docs to make a section in a Zeek tutorial and noticed that they need a little love. Here's part of that love.

I thought about enabling some of the RST lints in the Zeek docs, like double-backticks for code, but apparently it's in the docs style guide for ZKG to use single backticks sometimes. And I don't feel like walking through 50 cases of that right now to clean it up, these were just random things I noticed reading through

@evantypanski evantypanski force-pushed the topic/etyp/minor-docs-fixes branch 4 times, most recently from 7750873 to 5a2c618 Compare September 10, 2025 20:41
@evantypanski
Copy link
Copy Markdown
Member Author

Sorry I was silly and included something I shouldn't; removed and put them in the same small commit

Comment thread doc/package.rst Outdated
Mainly removing some `bro` references that will be considered outdated
because versioning is different and fixing minor typos.
@evantypanski evantypanski force-pushed the topic/etyp/minor-docs-fixes branch from 5a2c618 to 9433ac9 Compare September 16, 2025 19:22
@evantypanski evantypanski merged commit 7d70731 into master Sep 16, 2025
5 checks passed
@evantypanski evantypanski deleted the topic/etyp/minor-docs-fixes branch September 16, 2025 19:59
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