Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove outdated rustdoc for Issue module #4141

Merged
merged 1 commit into from
Apr 30, 2024
Merged

Conversation

agourlay
Copy link
Member

This PR removes the outdated rustdoc for the Issues module.

When using cargo test --all locally I currently get:

   Doc-tests issues

running 1 test
test lib/common/issues/src/lib.rs - (line 7) ... FAILED

failures:

---- lib/common/issues/src/lib.rs - (line 7) stdout ----
error[E0407]: method `distinctive` is not a member of trait `Issue`
  --> lib/common/issues/src/lib.rs:25:5
   |
21 | /     fn distinctive(&self) -> &str {
22 | |         &self.distinctive
23 | |     }
   | |_____^ not a member of trait `Issue`

error[E0046]: not all trait items implemented, missing: `instance_id`
  --> lib/common/issues/src/lib.rs:24:1
   |
20 | impl Issue for DummyIssue {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^ missing `instance_id` in implementation
   |
   = help: implement the missing item: `fn instance_id(&self) -> &str { todo!() }`

error[E0599]: no method named `code` found for struct `DummyIssue` in the current scope
  --> lib/common/issues/src/lib.rs:47:41
   |
8  | pub(crate) struct DummyIssue {
   | ---------------------------- method `code` not found for this struct
...
43 | issues::solve(DummyIssue::new("issue1").code()); // returns true if the issue was solved
   |                                         ^^^^ method not found in `DummyIssue`

The rational for removing it is that this doc is not currently checked by our CI pipeline due to limitation in nextest.
It would be a manual chore to keep it up to date for little gain at the end.

@agourlay agourlay requested review from coszio and timvisee April 30, 2024 07:01
@agourlay agourlay merged commit 8ec87fd into dev Apr 30, 2024
17 checks passed
@agourlay agourlay deleted the remove-outdated-issue-mod-doc branch April 30, 2024 07:24
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