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.

Sign up for GitHub

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

Jump to bottom

Rename the ignore file annotation to ignore all #169

Closed
dcastro opened this issue Sep 25, 2022 · 0 comments · Fixed by #199
Closed

Rename the ignore file annotation to ignore all #169

dcastro opened this issue Sep 25, 2022 · 0 comments · Fixed by #199
Assignees
@Sorokin-Anton
Milestone
0.3.0

Comments

@dcastro
Copy link
Member

dcastro commented Sep 25, 2022 •
edited
Loading

Clarification and motivation

In this comment, we discussed how a user could reasonably assume the --ignored <file> config/CLI option and the <--! xrefcheck: ignore file --> annotation do the same thing, even though they don't.

  1. The --ignored <file> option tells xrefcheck to pretend that file doesn't exist
    • All references to that file will be invalid
    • If <file> is a markdown file, references from that file will not be verified.
  2. The ignore file annotation, however, only tells xrefcheck not to verify references from that file. References to it will still be verified.

To avoid potential confusions, let's rename the ignore file annotation to ignore all.

Acceptance criteria

  • The ignore file annotation has been renamed to ignore all.
@dcastro dcastro added this to the 0.3 milestone Sep 25, 2022
@Sorokin-Anton Sorokin-Anton self-assigned this Oct 19, 2022
Sorokin-Anton added a commit that referenced this issue Oct 19, 2022
@Sorokin-Anton
[#169] Rename ignore file annotation to ignore all
64c1139 
Problem: as in #169, `ignore file` annotation is ignoring
not file itself but all links at file, which is not obvious

Solution: rename it to `ignore all`

Also renamed `IgnoreMode` constructors to from `Link`, `Paragraph`, `All` to
more readable  `IgnoreLink`, `IgnoreParagraph` and `IgnoreAll`
Sorokin-Anton added a commit that referenced this issue Oct 19, 2022
@Sorokin-Anton
[#169] Rename ignore file annotation to ignore all
302cd58 
Problem: as in #169, `ignore file` annotation is ignoring
not file itself but all links at file, which is not obvious

Solution: rename it to `ignore all`

Also renamed `IgnoreMode` constructors to from `Link`, `Paragraph`, `All` to
more readable  `IgnoreLink`, `IgnoreParagraph` and `IgnoreAll`
@Sorokin-Anton Sorokin-Anton mentioned this issue Oct 19, 2022
Merged
8 tasks
Sorokin-Anton added a commit that referenced this issue Oct 19, 2022
@Sorokin-Anton
[#169] Rename ignore file annotation to ignore all
3d200ee 
Problem: as in #169, `ignore file` annotation is ignoring
not file itself but all links at file, which is not obvious

Solution: rename it to `ignore all`

Also renamed `IgnoreMode` constructors to from `Link`, `Paragraph`, `All` to
more readable  `IgnoreLink`, `IgnoreParagraph` and `IgnoreAll`
Sorokin-Anton added a commit that referenced this issue Oct 26, 2022
@Sorokin-Anton
[#169] Rename ignore file annotation to ignore all
23b5272 
Problem: as in #169, `ignore file` annotation is ignoring
not file itself but all links at file, which is not obvious

Solution: rename it to `ignore all`

Also renamed `IMFile :: IgnoreMode` and `IMSFile :: IgnoreModeState`
to `IMAll` and `IMSAll`
Sorokin-Anton added a commit that referenced this issue Oct 26, 2022
@Sorokin-Anton
Merge pull request #199 from serokell/Sorokin-Anton/#169-rename-ignor…
2f2fce5 
…e-file-annotation

[#169] Rename `ignore file` annotation to `ignore all`
Sorokin-Anton added a commit that referenced this issue Oct 26, 2022
@Sorokin-Anton
fixup! [#169] Rename ignore file annotation to ignore all
6e23a6d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Sorokin-Anton Sorokin-Anton

Labels
None yet
Projects
None yet
Milestone
0.3.0
Development

Successfully merging a pull request may close this issue.

[#169] Rename ignore file annotation to ignore all serokell/xrefcheck
2 participants
@dcastro @Sorokin-Anton