microsoft / microsoft/api-guidelines
orderBy: Clarify meaning of "A special case of such an expression is a property path terminating on a primitive property"
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
What does this sentence mean (in the section about orderBy)?
The value of the orderby parameter is a comma-separated list of expressions used to sort the items. A special case of such an expression is a property path terminating on a primitive property.
Surely all orderBy strings refer to a specific property. What is meant by 'primitive' property, and why is that relevant here?
Thanks.
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
Start by locating the orderBy section in the API guidelines and read the quoted sentence in context. Clarify what “primitive property” means and why the special case matters, with the work complete when the wording answers those questions for readers.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100