search

Azure / azure-sdk-for-js

This repository is for active development of the Azure SDK for JavaScript (NodeJS & Browser). For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/javascript/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-js.
MIT License
2.07k stars 1.19k forks source link

Mentioning which language the sample code is written in #5291

Closed ShunyaWatanabe closed 4 years ago

ShunyaWatanabe commented 5 years ago

I was trying to run the sample code for custom vision prediction using node but I couldn't run it. I am now assuming that the sample code on readme is written in TypeScript. If this is correct, maybe it would be nice to mention this so that the beginners won't waste time trying to figure out which language it is written in?

maggiepint commented 5 years ago

Hi,

This does make sense. @ramya-rao-a , @kaerm this is probably something we should keep on our radar. Have we put any thought into doing additional plain JS samples?

ramya-rao-a commented 5 years ago

@maggiepint The current set of cognitive services libraries are auto-generated. The sample in question is a code snippet in the readme file. We had to manually go and fix up all the samples because cognitive services has special needs when it comes to auth.

I would support maintaining 2 sets of samples for js and ts if the samples are maintained elsewhere than the readme

For now, I would say the best course of action would be to update the samples in the readme to be in javascript instead.

ramya-rao-a commented 4 years ago

@joheredi

Looks like some of the cognitives services sdk readme do have the note that the sample is in Typescript, see https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/cognitiveservices/cognitiveservices-customvision-training#how-to-use

Please review the readme of all the cognitive services sdks to ensure we have the same note

joheredi commented 4 years ago

@ShunyaWatanabe thanks for bringing this up!

@ramya-rao-a, just looked at the other cognitive services SDKs and Custom Vision Prediction is the only one missing the note. I have sent out a PR to fix it