search

microsoft / pxt

Microsoft MakeCode (PXT - Programming eXperience Toolkit)
https://makecode.com
MIT License
2.1k stars 588 forks source link

Improve sig snippet to display alias statement #10212

Open sae220 opened 1 month ago

sae220 commented 1 month ago

Before @ganicke 's PR (#10078), alias statements have same reference (or help doc) as original statements have.

old_remove_at

Thanks to his PR, _removeAtStatement (alias for removeAt) has an original page, but it is not altogether good, I guess. For blocks users, removeAt and _removeAtStatement looks different statements, but they are essentially the same. And of course, JavaScript/Python users shouldn't use _removeAtStatement.

old_remove_at_statement

So, I suggest to improve sig snippet to display alias statement. new_remove_at

And anyway _popStatement, _shiftStatement and _unshiftStatement (as _removeAtStatement) should have thier reference.

@ganicke @abchatra

abchatra commented 1 month ago

@ganicke is this good to merge?