Repository navigation
Conversation
why: Python, Swift, Ruby and Lua listed only the parameters a doc comment described, so a Ruby Server.start page showed no Parameters section for executable:, config:, timeout: and cancel:, while C# listed its parameters with their types whether documented or not. what: - List each declared parameter with its type in every port - Link every parameter name in the signature to its entry - For Python, list the implementation's parameters, not each @overload stub's, and leave out an undocumented self or cls receiver; leave out Lua's self receiver too - Update the tests that pinned documented-only lists
Contributor
Author
|
Folded into #157, which now carries every fix from the 2026-10-18 review on one branch so they share one CI run, preview and deploy. This commit is on that branch unchanged. Discussion and evidence stay here. |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Python, Swift, Ruby and Lua listed only the parameters a doc comment described. The Ruby
Server.startpage therefore had no Parameters section forexecutable:,config:,timeout:andcancel:, while C# listedoptions (ServerConnectionOptions?)whether or not it was documented.Every port now lists each declared parameter with its type, and every parameter name in the signature links to its entry.
@overloadstub's, which repeat them with narrower types.self, orclsin Python, is the receiver the call never passes, so it is not listed or linked. Lua'sselfis handled the same way.paramsarrays still list only the declared name.Tests: the tests that pinned documented-only lists for Ruby, Lua, Swift and Python now assert the new rule, and a new test covers the receiver rule. The full site suite passes (4,600 tests), and lint passes.