Error description in readme.md

Open Beginner friendly
#19 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
java
Domain
documentation

Research direction

Open README.md and find the “Extended syntax supported” section. Compare the documented start-with and regex expressions with the linked Jsoup selector syntax, then correct the conflicting start-with notation and verify that the examples are distinct and consistent.

Written by the indexing model from the issue text.

Description

In the Extended syntax supported section:
https://github.com/code4craft/xsoup/blob/master/README.md

The expression of start with function and regex function are conflicted:
attribute value start with: [@key~=value] yes
attribute value match regex: [@key~=value] yes

According to Jsoup selector syntax:
http://jsoup.org/cookbook/extracting-data/selector-syntax
In the selector overview of Jsoup:
[attr^=value], [attr$=value], [attr_=value]: elements with attributes that start with, end with, or contain the value, e.g. [href_=/path/]

Hence I think the expression of start with in Xsoup should be that:
attribute value start with: [@key^=value]

Dominant language
Java
Stars
474
Forks
148
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from code4craft/xsoup

All issues in code4craft/xsoup

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.