microsoft / pxt

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

javascript documentation not found for some functions #2061

Closed nielsswinkels closed 7 years ago

nielsswinkels commented 7 years ago

For some javascript functions, for example while-loop, when you right click and select help it shows:

Oops We could not load the documentation, please check your internet connection.

Trying to open the help into a new tab will try to load the url https://pxt.microbit.org/reference//while which is missing. I think there were some more functions where this happens, but I haven't made a list of them.

pelikhan commented 7 years ago

The double // is suspicious.

Get Outlook for iOShttps://aka.ms/o0ukef


From: Niels notifications@github.com Sent: Tuesday, May 9, 2017 1:51:31 PM To: Microsoft/pxt Cc: Subscribed Subject: [Microsoft/pxt] javascript documentation not found for some functions (#2061)

For some javascript functions, for example while-loop, when you right click and select help it shows:

Oops We could not load the documentation, please check your internet connection.

Trying to open the help into a new tab will try to load the url https://pxt.microbit.org/reference//while which is missing. I think there were some more functions where this happens, but I haven't made a list of them.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMicrosoft%2Fpxt%2Fissues%2F2061&data=02%7C01%7Cjhalleux%40microsoft.com%7C6c1ab0d28eba42c7799408d4971d2ea3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636299598983496285&sdata=6RCSXrxE9TGVZ%2FqxgHenkfg8IBRMfW%2F8p8nI5i%2FhfVo%3D&reserved=0, or mute the threadhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAD-4Kcm1NQ9-1obML7J55z2jcumRtxCRks5r4NHTgaJpZM4NV3Tr&data=02%7C01%7Cjhalleux%40microsoft.com%7C6c1ab0d28eba42c7799408d4971d2ea3%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C636299598983496285&sdata=MD23BcYyC921BLQKfZVKMOO3CMUIcoc%2BjbJmw5vudT4%3D&reserved=0.

nielsswinkels commented 7 years ago

The while only has documentation under the category /blocks/ in the docs, not under /reference/. This url works, but only describes it as a block: https://pxt.microbit.org/blocks/loops/while

tballmsft commented 7 years ago

@ganicke, can you look into this?

ganicke commented 7 years ago

Sure, I'll take a look.

ganicke commented 7 years ago

Are you talking about the context help from the block in the editor not opening the while topic?

With a quick check it seems to work both on https://pxt.microbit.org and in https://pxt.microbit.org/beta. Look at the capture here and see if I'm doing the repro correctly:

while-help

nielsswinkels commented 7 years ago

No I'm talking about doing this while in javascript text mode, not blocks. (btw what do you use to make these gifs?)

ganicke commented 7 years ago

Hi, I use ScreenToGif (get it at http://www.screentogif.com). Post your repro if you can. You frame the recorder over the area you want captured so you don't need to grab the entire window if you don't want to.

ganicke commented 7 years ago

Will look into this again when a repro is provided. Loop docs are rooted under /blocks as are conditionals and variables.

nielsswinkels commented 7 years ago

pxt doc bug

nielsswinkels commented 7 years ago

The problem is that it works for blocks but not for javascript

lock[bot] commented 5 years ago

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.