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

Refine documentation #8551

Merged
merged 2 commits into from
Mar 11, 2022
Merged

Refine documentation #8551

merged 2 commits into from
Mar 11, 2022

Conversation

koppor
Copy link
Member

@koppor koppor commented Mar 8, 2022

Some more documentation refinements.

Follow-up to 3c247ff

  • 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.

@tobiasdiez
Copy link
Member

I don't quite understand what you want to say with this. The medline importer inherits from Parser, and that is what is used in the fetcher.

@Siedlerchr
Copy link
Member

Siedlerchr commented Mar 9, 2022

We were discussing the differences between ParserBasedFetcher and non parser fetcher
Maybe you can add a little bit of clarity

@tobiasdiez
Copy link
Member

Normally, the fetcher invokes an api and then parses the response (to get BibEntries). This kind of workflow is supported by the parser-based fetcher. Sometimes you need to have more flexibility, i.e. call multiple endpoints and merge the results etc. In theses cases, one has to use the non-parser-based fetcher interfaces. But I think this is already described in the docstrings.

@koppor
Copy link
Member Author

koppor commented Mar 9, 2022

The comments were not as clear as you provided in your comment. I added your text at 57d1b2a (#8551).

@koppor
Copy link
Member Author

koppor commented Mar 9, 2022

In general, I like the concept of links and would like to guide a novice in the code for more details.

@Siedlerchr Siedlerchr merged commit f62bef0 into main Mar 11, 2022
@Siedlerchr Siedlerchr deleted the refine-fetcher-doc branch March 11, 2022 19:14
@Siedlerchr Siedlerchr restored the refine-fetcher-doc branch March 11, 2022 19:14
Siedlerchr added a commit that referenced this pull request Mar 11, 2022
Siedlerchr added a commit that referenced this pull request Mar 11, 2022
Siedlerchr added a commit that referenced this pull request Mar 11, 2022
Siedlerchr added a commit that referenced this pull request Mar 11, 2022
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)
@koppor koppor deleted the refine-fetcher-doc branch March 14, 2022 06:32
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.

3 participants