Skip to content

chore: lint docs too

Dmitry Rodionov requested to merge dkr/lint-docs-in-ci into master

Summary

  • chore: lint docs too

The most obvious benefit is link checking. This is especially useful with rust-analyzer, because it allows to jump to definition of the item referenced in the doc comment.

The patch also makes CI to use make lint to avoid duplication.

Ensure that

  • New code is covered by tests
  • API is documented
  • Changelog is up to date
  • (if Lua API changed) Lua API version is bumped in luamod.rs
  • (if API docs changed) A follow-up doc issue is created in picodata/docs and linked here
Edited by Dmitry Rodionov

Merge request reports