Skip to content

Refine documentation on logging#8550

Merged
Siedlerchr merged 4 commits into
mainfrom
fix-logger-doc
Mar 11, 2022
Merged

Refine documentation on logging#8550
Siedlerchr merged 4 commits into
mainfrom
fix-logger-doc

Conversation

@koppor

@koppor koppor commented Mar 8, 2022

Copy link
Copy Markdown
Member

We switched to tinylog. This PR fixes the documentation.

  • Change in CHANGELOG.md described in a way that is understandable for the average user (if applicable)
  • Tests created for changes (if applicable)
  • Manually tested changed features in running JabRef (always required)
  • Screenshots added in PR description (for UI changes)
  • Checked documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request to the documentation repository.

@koppor koppor added the status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers label Mar 8, 2022
@@ -1,2 +1,3 @@
level = info
writer = console
level@org.jabref.model.entry.BibEntry = debug

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this only meant as an example, or actually desired?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to choose a class not having extensive debug statements. I wanted to keep a line directly working. Think of novices not sure about comment characters in .properties file etc.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And we reference it in the udpated howto:

In the .properties file, this is done for org.jabref.model.entry.BibEntry.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are comments in a properties file allowed? If yes, it would be nice to give a few examples (i.e. activate debug logging for a particular class, for a module, for everything).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hash character #this is a comment work

Comment thread docs/getting-into-the-code/code-howtos.md Outdated
@Siedlerchr Siedlerchr merged commit f033ff3 into main Mar 11, 2022
@Siedlerchr Siedlerchr deleted the fix-logger-doc branch March 11, 2022 19:15
Siedlerchr added a commit that referenced this pull request Mar 13, 2022
* upstream/main:
  Update RemoteSetupTest.java, adding eq() function from mockito (#8561)
  readd encoding after merge
  Open office refactor finalization (formerly OObranch J cleanup) (#7795)
  Revert "Refine documentation (#8551)" (#8560)
  Refine documentation on logging (#8550)
  Revert "Refine documentation (#8551)" (#8559)
  Refine documentation (#8551)
  New Crowdin updates (#8557)
  New Crowdin updates (#8553)
  Fix missing metadata in BibDatabaseContext (#8556)
  Add encoding detection (and pin export to UTF-8) (#8506)
  Add Missing Fillers/Extractors for Supported Fields and Support Day Conversion (#8531)
  Bump checkstyle from 9.3 to 10.0 (#8544)
  Fix online link detection in entry editor (#8514)
  Add some JavaDoc to Fetchers
  Support two argument form of \abx@aux@cite macro in DefaultAuxParser (#8549)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: logging status: ready-for-review Pull Requests that are ready to be reviewed by the maintainers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants