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

Update README.md #1325

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #1325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ It's a great way to learn.
* [Blockchain / Cryptocurrency](#build-your-own-blockchain--cryptocurrency)
* [Bot](#build-your-own-bot)
* [Command-Line Tool](#build-your-own-command-line-tool)
* [Database](#build-your-own-database)
* [Database](#build-your-own-databases)
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Inconsistent Link Anchor and Link Text in README.md

  • The list item currently uses * [Database](#build-your-own-databases) which suggests a plural reference.
  • However, the corresponding header in the file is #### Build your own \Database`(singular), meaning that the auto-generated anchor would likely be#build-your-own-databaserather than#build-your-own-databases`.
  • To satisfy markdownlint MD051 and maintain consistency, either update the header to use the plural form (i.e., change it to "Build your own Databases") or adjust the link's anchor and text to match the current header (e.g., * [Database](#build-your-own-database)).
🔗 Analysis chain

Link Text Consistency and Anchor Verification

The AI summary indicates that the "Database" link should be renamed to "Databases" and the anchor updated accordingly. In the current diff, the anchor has been updated to #build-your-own-databases, but the link text remains as "Database". For consistency, consider updating the link text to "Databases".

For example, you might apply the following diff:

-* [Database](#build-your-own-databases)
+* [Databases](#build-your-own-databases)

Additionally, please verify that the anchor #build-your-own-databases correctly corresponds to the relevant section header in the document (to satisfy markdownlint MD051 regarding valid link fragments).

🏁 Scripts executed

The following scripts were executed for the analysis:

Error: No shell scripts or web queries found

Script:

#!/bin/bash
# Check if README.md contains a section header that corresponds to the anchor #build-your-own-databases.
# Markdown headers are case-insensitive and spaces are typically replaced by hyphens.
# We'll search for headers that contain "Build" and "Databases" in some form.

echo "Searching for a header corresponding to the 'build-your-own-databases' anchor in README.md:"
grep -i -E '^(#+)\s+.*build.*databases' README.md || echo "No matching header found."

Length of output: 311

Script:

#!/bin/bash
# List all headers in README.md to review if there's a section corresponding to the anchor #build-your-own-databases.
echo "Listing all headers in README.md:"
grep '^#' README.md || echo "No headers found."

Length of output: 1172

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

17-17: Link fragments should be valid
null

(MD051, link-fragments)

* [Docker](#build-your-own-docker)
* [Emulator / Virtual Machine](#build-your-own-emulator--virtual-machine)
* [Front-end Framework / Library](#build-your-own-front-end-framework--library)
Expand Down