-
Notifications
You must be signed in to change notification settings - Fork 588
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.
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
Improve sig snippet to display alias statement #10212
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
code looks good! however, please leave the remove-at-statement.md file.
our docs are served "live-ish" from this repo and so changing this now will break existing targets that don't have your change to the help annotation in pxt-core.d.ts. this file can be removed once this change has been propagated to other editors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The problem I have with combining these is that pop()
returns a value and _popStatement()
does not. This will either need to be noted in the common reference page or the seperate reference pages will need to remain.
@ganicke is this good to merge? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added my edits for the additional 'statement only' info.
removal of '_remove-at-statement.md' is reverted
Before @ganicke 's PR (#10078), alias statements have same reference (or help doc) as original statements have.
Thanks to his PR,
_removeAtStatement
(alias forremoveAt
) 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
.So, I suggest to improve sig snippet to display alias statement.
And anyway
_popStatement
,_shiftStatement
and_unshiftStatement
(as_removeAtStatement
) should have thier reference.@ganicke @abchatra