[go: nahoru, domu]

Skip to content

Commit

Permalink
fix markdown errors [1]
Browse files Browse the repository at this point in the history
  • Loading branch information
subhramit committed Jul 5, 2024
1 parent 9fa1707 commit 16eba01
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docs/code-howtos/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@ parent: Code Howtos

Following is a list of common errors encountered by developers which lead to failing tests, with their common solutions:

* `org.jabref.architecture.MainArchitectureTest` restrictStandardStreams <span style="color:red">FAILED</span>
* <span style="color:green">Fix</span> : Check if you've used ```System.out.println(...)``` (the standard output stream) to log anything into the console. This is an architectural violation, as you should use the Logger instead for logging. More details on how to log can be found [here](https://devdocs.jabref.org/code-howtos/logging.html).
* `org.jabref.architecture.MainArchitectureTest` `restrictStandardStreams` FAILED
- Fix: Check if you've used ```System.out.println(...)``` (the standard output stream) to log anything into the console. This is an architectural violation, as you should use the Logger instead for logging. More details on how to log can be found [here](https://devdocs.jabref.org/code-howtos/logging.html).

Check failure on line 11 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list style

docs/code-howtos/faq.md:11:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md

Check failure on line 11 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list indentation

docs/code-howtos/faq.md:11:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md

* `org.jabref.architecture.MainArchitectureTest` `doNotUseLogicInModel` FAILED
- Fix: One common case when this test fails is when you put any class purely containing business logic at some level inside the ```model``` directory (```org/jabref/model/```). To fix this, shift the class to a subdirectory within the ```logic``` directory (```org/jabref/logic/```).

Check failure on line 14 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list style

docs/code-howtos/faq.md:14:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md

Check failure on line 14 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list indentation

docs/code-howtos/faq.md:14:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md

* `org.jabref.architecture.MainArchitectureTest` doNotUseLogicInModel <span style="color:red">FAILED</span>
* <span style="color:green">Fix</span> : One common case when this test fails is when you put any class purely containing business logic at some level inside the ```model``` directory (```org/jabref/model/```). To fix this, shift the class to a subdirectory within the ```logic``` directory (```org/jabref/logic/```).

* `org.jabref.logic.l10n.LocalizationConsistencyTest` findMissingLocalizationKeys <span style="color:red">FAILED</span>
* <span style="color:green">Fix</span> : You have probably used Strings that are visible on the UI (to the user) but not wrapped them using ```Localization.lang(...)``` and added them to the localization properties file (https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties).
* `org.jabref.logic.l10n.LocalizationConsistencyTest` `findMissingLocalizationKeys` FAILED
- Fix: You have probably used Strings that are visible on the UI (to the user) but not wrapped them using ```Localization.lang(...)``` and added them to the [localization properties file](https://github.com/JabRef/jabref/blob/main/src/main/resources/l10n/JabRef_en.properties).

Check failure on line 17 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list style

docs/code-howtos/faq.md:17:1 MD004/ul-style Unordered list style [Expected: asterisk; Actual: dash] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md004.md

Check failure on line 17 in docs/code-howtos/faq.md

View workflow job for this annotation

GitHub Actions / Markdown

Unordered list indentation

docs/code-howtos/faq.md:17:1 MD007/ul-indent Unordered list indentation [Expected: 2; Actual: 4] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md007.md
Read more about the background and format of localization in JabRef [here](https://devdocs.jabref.org/code-howtos/localization.html).

0 comments on commit 16eba01

Please sign in to comment.