jquery / jquery/api.jquery.com
Misleading text in the ajax `ifModified` documentation
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 325
- Forks
- 260
- PR merge metrics
- No merged PRs in 30d
Description
Version: 2.1.1
It's possible that I'm misinterpreting this, but the documentation for ifModified explains:
To cause the request to report failure if the asset has not been modified since the last request, set
ifModifiedto true.
Based on this, I expected a request to an unmodified resource to reject the Deferred object. However, it actually resolves. It seems unlikely that this behavior isn't intentional, so perhaps the wording there could be improved to explain that the Deferred will be resolved?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the ajax ifModified documentation entry and compare its wording with the behavior described in the issue. Clarify that an unmodified resource resolves the Deferred rather than implying that the request fails, then verify the revised text against the documented behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100