Skip to content

Commit

Permalink
Update linter install link and fix declare_bevy_lint! visibility (#220
Browse files Browse the repository at this point in the history
)

Now when you run `bevy lint` (from the CLI) and the linter is _not_
installed, it will recommend installing it from [the
website](https://thebevyflock.github.io/bevy_cli/bevy_lint/), not
Github.

Additionally, it looks like I accidentally commented out
`#[doc(hidden)]` on `declare_bevy_lint!` in #216, so this fixes that
too.

---------

Co-authored-by: TimJentzsch <commits@timjen.net>
  • Loading branch information
BD103 and TimJentzsch authored Jan 12, 2025
1 parent 0558371 commit 14d5a27
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion bevy_lint/src/lint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ pub struct LintGroup {
/// }
/// ```
#[macro_export]
// #[doc(hidden)]
#[doc(hidden)]
macro_rules! declare_bevy_lint {
{
$(#[$attr:meta])*
Expand Down
2 changes: 1 addition & 1 deletion src/lint.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ pub fn find_bevy_lint() -> anyhow::Result<PathBuf> {
} else {
ensure!(
bevy_lint_path.exists(),
"`bevy_lint` could not be found at {}. Please follow the instructions at <https://github.com/TheBevyFlock/bevy_cli> to install it.",
"`bevy_lint` could not be found at {}. Please follow the instructions at <https://thebevyflock.github.io/bevy_cli/bevy_lint/#installation> to install it.",
bevy_lint_path.display(),
);
}
Expand Down

0 comments on commit 14d5a27

Please sign in to comment.