Commit cda0221

committed

ci/doc: check for private items as well

We check also the documentation of private items to find linting errors, such as broken intra-doc links.

1 parent 01b27af commit cda0221Copy full SHA for cda0221

File tree

-1

lines changed

-1

lines changed

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ jobs:`
`98`	`98`	`cargo xtask clippy --warnings-as-errors`
`99`	`99`
`100`	`100`	`- name: Run cargo doc`
`101`		`- run: cargo xtask doc --warnings-as-errors`
	`101`	`+ run: cargo xtask doc --warnings-as-errors --document-private-items`
`102`	`102`
`103`	`103`	`- name: Verify generated code is up-to-date`
`104`	`104`	`run: cargo xtask gen-code --check`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -86,6 +86,11 @@ pub struct DocOpt {`
`86`	`86`	`#[clap(long, action)]`
`87`	`87`	`pub open: bool,`
`88`	`88`
	`89`	`+ /// Tells whether private items should be documented. This is convenient to check for`
	`90`	`+ /// broken intra-doc links in private items.`
	`91`	`+ #[clap(long, action)]`
	`92`	`+ pub document_private_items: bool,`
	`93`	`+`
`89`	`94`	`#[clap(flatten)]`
`90`	`95`	`pub warning: WarningOpt,`
`91`	`96`	`}`

Comments

(0)