Skip to content

Update popen_handle term description #5104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Tracked by #5096
AArdeev opened this issue May 13, 2025 · 0 comments · May be fixed by #5117
Open
Tracked by #5096

Update popen_handle term description #5104

AArdeev opened this issue May 13, 2025 · 0 comments · May be fixed by #5117
Assignees
@AArdeev
Labels
rewrite [nature] Revise existing text for structure/phrasing/terms

Comments

@AArdeev
Copy link
Contributor

AArdeev commented May 13, 2025 •
edited
Loading

Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/popen/
SME: @ Totktonada

Details

  • Currently, the document does not provide a consistent and transparent explanation of the popen_handle term.
  • With that, a reader may get a confused or incorrect understanding.
  • We need to define clearly what meaning does the popen_handle have and change the description in the article in such a way, that this meaning is provided transparently and consistently to the reader.
  • As a result, the reader will gain a better understanding of the document and of the product.
@AArdeev AArdeev mentioned this issue May 13, 2025
Open
5 tasks
@AArdeev AArdeev self-assigned this May 13, 2025
@AArdeev AArdeev added the rewrite [nature] Revise existing text for structure/phrasing/terms label May 13, 2025
@AArdeev AArdeev changed the title Update ph term description Clarifyph term description May 13, 2025
@AArdeev AArdeev changed the title Clarifyph term description Update ph term description May 13, 2025
@AArdeev AArdeev changed the title Update ph term description Update popen_handle term description May 13, 2025
AArdeev added a commit that referenced this issue May 19, 2025
@AArdeev
Updades description of the popen module
608ffb3 
Got rid of repeated "ph" abbriviateion everywhere except for examples
Removed "Index" heading
Added Subheadings for constructors, fields, and constants
Fixes #5104
@AArdeev AArdeev linked a pull request May 19, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AArdeev AArdeev

Labels
rewrite [nature] Revise existing text for structure/phrasing/terms
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Updades description of the popen module tarantool/doc
1 participant
@AArdeev