You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@asyncband.apache.org by "nanami-0713 (via GitHub)" <gi...@apache.org> on 2026/10/14 13:30:27 UTC

[PR] docs(semaphore): reference the actual permits parameter in method summaries [asyncband]

nanami-0713 opened a new pull request, #371:
URL: https://github.com/apache/asyncband/pull/371

   ## Summary
   
   - Rename the permit-count doc symbol `n` to `permits` in the summaries of `Semaphore::release`, `try_acquire`, `acquire`, `try_acquire_owned`, and `acquire_owned`, so each summary references the parameter its signature actually declares.
   - The stale `n` wording was inherited from Tokio's semaphore, whose count-taking methods do name the argument `n`; the rename to `permits` made as part of this crate's contract changes had not reached the summaries. Within this module `n` is also a real parameter name (`reduce_permits`, `split`), so the same rendered symbol referred to an actual argument in some methods and to a renamed one in others.
   - `reduce_permits(n)` and both `split(n)` methods keep their existing docs, which already match their real parameter names. Documentation-only, so no CHANGELOG entry per the contribution guidelines; doctests pass.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org
For additional commands, e-mail: commits-help@asyncband.apache.org


Re: [PR] docs(semaphore): reference the actual permits parameter in method summaries [asyncband]

Posted by "nanami-0713 (via GitHub)" <gi...@apache.org>.
nanami-0713 commented on PR #371:
URL: https://github.com/apache/asyncband/pull/371#issuecomment-6169833127

   > Thanks!
   
   Thanks! Happy to adjust the wording if anything should change.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org
For additional commands, e-mail: commits-help@asyncband.apache.org


Re: [PR] docs(semaphore): reference the actual permits parameter in method summaries [asyncband]

Posted by "tisonkun (via GitHub)" <gi...@apache.org>.
tisonkun merged PR #371:
URL: https://github.com/apache/asyncband/pull/371


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@asyncband.apache.org
For additional commands, e-mail: commits-help@asyncband.apache.org