Example in section 4.1 "Object" does not show an object with type `Object`
Open
Nobody has claimed this yet.
Next version
pr-requested
- Dominant language
- HTML
- Stars
- 313
- Forks
- 70
- PR merge metrics
- No merged PRs in 30d
Description
Example 7 in section 4.1 "Object" shows a Note object. Note is a sub-type of Object. Is this a good example of Object? Should it be made clearer that the object is an Object because of the type hierarchy?
Contributor guide
No contributing guide indexed for this repository
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
Start at section 4.1 "Object" and inspect Example 7, which currently shows a Note object. Decide whether the example needs an explicit explanation of the Object type hierarchy; done means the example or accompanying text makes clear why Note demonstrates Object, or replaces it with an unambiguous Object example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 56/100