Skip to content

docs: fix link formatting in ADR 0012#15201

Merged
Siedlerchr merged 2 commits into
JabRef:mainfrom
codepurple007:main
Feb 23, 2026
Merged

docs: fix link formatting in ADR 0012#15201
Siedlerchr merged 2 commits into
JabRef:mainfrom
codepurple007:main

Conversation

@codepurple007

@codepurple007 codepurple007 commented Feb 23, 2026

Copy link
Copy Markdown
Contributor

Related issues and pull requests

Closes #14897

PR Description

I have updated the link formatting in docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md. I changed the raw URL to a standard Markdown link for PR #6687 to make the documentation cleaner and more consistent.

Steps to test

  1. Open the file docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md.
  2. Locate the "Decision Outcome" section to see the new formatted link.

Checklist

  • I own the copyright of the code submitted and I license it under the MIT license
  • I manually tested my changes in running JabRef (always required)
  • [/] I added JUnit tests for changes (if applicable)
  • [/] I added screenshots in the PR description (if change is visible to the user)
  • [/] I added a screenshot in the PR description showing a library with a single entry with me as author and as title the issue number
  • [/] I described the change in CHANGELOG.md in a way that can be understood by the average user (if change is visible to the user)
  • [/] I checked the user documentation for up to dateness and submitted a pull request to our user documentation repository

Standardized the PR link format to improve documentation clarity. Part of JabRef#14897.
@qodo-free-for-open-source-projects

Copy link
Copy Markdown
Contributor

Review Summary by Qodo

Standardize markdown link formatting in ADR 0012

📝 Documentation

Grey Divider

Walkthroughs

Description
• Standardized markdown link formatting in ADR 0012
• Changed inline URL to proper markdown link syntax
• Improved documentation readability and consistency
Diagram
flowchart LR
  old["[As described here (comment)](URL)"]
  new["As described in [PR #6687](URL)"]
  old -- "standardize format" --> new
Loading

Grey Divider

File Changes

1. docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md 📝 Documentation +1/-1

Standardize PR link markdown formatting

• Changed inline URL text from "(comment)" to descriptive "PR #6687"
• Converted to standard markdown link syntax for better readability
• Improved documentation clarity in Decision Outcome section

docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md


Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

qodo-free-for-open-source-projects Bot commented Feb 23, 2026

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider


Remediation recommended

1. Inconsistent link wording🐞 Bug ✓ Correctness
Description
The Decision Outcome now uses a new PR-link phrasing, but the same ADR still contains the old
phrasing for the same PR elsewhere, and the new sentence lacks trailing punctuation. This is low
impact but reduces documentation consistency/readability in the ADR.
Code

docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md[26]

+As described in [PR #6687](https://github.com/JabRef/jabref/pull/6687)
Evidence
Line 26 introduces the new standalone sentence without a period. Later in the same document, the
same PR URL is still referenced using the older wording/link text, creating an inconsistency within
one ADR.

docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md[24-27]
docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md[32-35]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The ADR now references the same PR with two different link texts/styles, and the new “As described…” line reads like a full sentence but has no trailing period.
### Issue Context
This is documentation-only, but the PR’s goal is to improve readability; keeping link styling consistent within the same ADR will help.
### Fix Focus Areas
- docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md[24-27]
- docs/decisions/0012-handle-different-bibEntry-formats-of-fetchers.md[32-35]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

@github-actions

Copy link
Copy Markdown
Contributor

Hey @codepurple007! 👋

Thank you for contributing to JabRef!

We have automated checks in place, based on which you will soon get feedback if any of them are failing. We also use Qodo for review assistance. It will update your pull request description with a review help and offer suggestions to improve the pull request.

After all automated checks pass, a maintainer will also review your contribution. Once that happens, you can go through their comments in the "Files changed" tab and act on them, or reply to the conversation if you have further inputs. You can read about the whole pull request process in our contribution guide.

Please ensure that your pull request is in line with our AI Usage Policy and make necessary disclosures.

@github-actions github-actions Bot added first contrib good first issue An issue intended for project-newcomers. Varies in difficulty. status: changes-required Pull requests that are not yet complete labels Feb 23, 2026
@testlens-app

testlens-app Bot commented Feb 23, 2026

Copy link
Copy Markdown

✅ All tests passed ✅

🏷️ Commit: 8033b88
▶️ Tests: 9698 executed
🟡 Checks: 43/51 completed


Learn more about TestLens at testlens.app.

@InAnYan InAnYan left a comment

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.

Well... I don't think this PR is linked to the mentioned issue, and the changes do not really correspond to the PR description...

But... I kinda agree with the change...

@jabref-machine

Copy link
Copy Markdown
Collaborator

You committed your code on the main brach of your fork. This is a bad practice. The right way is to branch out from main, work on your patch/feature in that new branch, and then get that branch merged via the pull request (see GitHub flow).

For this pull request, this is OK. For subsequent pull requests, please start with a different branch with a proper branch name. See CONTRIBUTING.md for more details.

@Siedlerchr Siedlerchr merged commit fc7dc62 into JabRef:main Feb 23, 2026
49 of 52 checks passed
@jabref-machine

Copy link
Copy Markdown
Collaborator

While the PR was in progress, a new version of JabRef has been released.

You have to merge upstream/main and move your entry in CHANGELOG.md up to the section ## [Unreleased].

@Stewori

Stewori commented Feb 24, 2026

Copy link
Copy Markdown
Collaborator

The issue description links the wrong issue (which was falsely closed as a side-effect). Assuming that was a typo, please make sure to identify and close the actual issue this PR solved.

@codepurple007

Copy link
Copy Markdown
Contributor Author

I am very greatful for the merge! My apologies for the confusion, the PR was intended to help with the cleanup for #14897. I will be more careful for the next time, on my next contribution!

Siedlerchr added a commit that referenced this pull request Feb 25, 2026
* refs/heads/main:
  Increase max assignments from 2 to 3
  Chore(deps): Bump io.zonky.test:embedded-postgres in /versions (#15213)
  Chore(deps): Bump jablib/src/main/resources/csl-styles (#15211)
  New Crowdin updates (#15208)
  Fix: Prevent creating empty or duplicate fields  (#15168)
  chore(deps): update jackson monorepo to v3.1.0 (#15203)
  Update KeywordEditor to work with escaping (#14929)
  Chore(deps): Bump com.dlsc.gemsfx:gemsfx in /versions (#15205)
  Chore(deps): Bump tools.jackson:jackson-bom in /versions (#15206)
  Fix: Reset External File Type to default (#15167)
  docs: fix link formatting in ADR 0012 (#15201)
RakockiW pushed a commit to RakockiW/jabref that referenced this pull request Mar 1, 2026
* docs: fix link formatting in ADR 0012

Standardized the PR link format to improve documentation clarity. Part of JabRef#14897.

* Fix formatting in decision document for fetcher handling

---------

Co-authored-by: Ruslan <ruslanpopov1512@gmail.com>
priyanshu16095 pushed a commit to priyanshu16095/jabref that referenced this pull request Mar 3, 2026
* docs: fix link formatting in ADR 0012

Standardized the PR link format to improve documentation clarity. Part of JabRef#14897.

* Fix formatting in decision document for fetcher handling

---------

Co-authored-by: Ruslan <ruslanpopov1512@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

first contrib good first issue An issue intended for project-newcomers. Varies in difficulty. status: changes-required Pull requests that are not yet complete

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some small repairs after Javadoc to Markdown conversion.

6 participants