Remove all examples of argumentless calls to :select()
Open
Nobody has claimed this yet.
2.10
behavior change
example
server
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Product: Tarantool
Since: 2.10.0
Root document:
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_space/select/
- https://www.tarantool.io/en/doc/latest/reference/reference_lua/box_index/select/
- TBD (needs research for pages with example of
:select()calls without arguments)
SME: @ alyapunov
This is doc part of the https://github.com/tarantool/tarantool/issues/6539
- For all cases:
:select():select(nil):select{}crud:select()crud:select(nil)crud:select{}
- Remove or re-write examples of the form
select ()from the documentation everywhere. Re-writting is prefferable if removing can break the logic of some complex examples. - Describe new critical log message (when user in using
select()in their lua code -- see #2838 for details - Add warning in select() function description
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 with the root box_space/select and box_index/select documentation pages, then search the documentation for the listed argumentless select() forms, including crud:select variants. Review issues #6539 and #2838 for scope and the critical log message details. Done means affected examples are removed or rewritten, the select() description includes the warning, and the new log message is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100