Azure-docs: Need precompiled C# sample code snippets

Created on 25 Jun 2019  Â·  8Comments  Â·  Source: MicrosoftDocs/azure-docs

The C# sample code snippets on this page are all C# Script (as in, edited in the Portal) which doesn't map to precompiled C# - the vast majority of C# Functions use cases. Nobody looks to the very bottom of the page to find the precompiled variant, and it requires extra cycles to figure out what maps to what. We should either add precompiled C# sample code alongside all the others, or replace the C# Script code w/ its Precompiled equivalent


Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Pri2 assigned-to-author azure-functionsvc doc-enhancement triaged

All 8 comments

Hi @brandonh-msft Thank you for your feedback! We have assigned this issue to the author to review further and take the right course of action.

@brandonh-msft of course, you are correct. @kashimiz or @cgillum does anyone have cycles to help convert these examples to C# class libraries? If not, I'll add the request to the general docs backlog.

I'm ramping up on another customer engagement right but now am happy to submit PRs for these changes when I'm done if it's still open.

I'd be happy to accept a PR for this if you have cycles. I've not yet had a chance to get to this but I agree it should be done.

@ggailey777, @cgillum

we've got a mix of ```csharp blocks as well as these [!code-csharp[Main](~/samples-durable-functions/samples/csx/E2_BackupSiteContent/run.csx)] blocks in the doc content.

I'm not sure what the latter does, how it works, or where those files are stored so I'm going to have to PR by using the code block (```csharp) syntax if that's ok?

@brandonh-msft: a [!code-csharp[Main](~/<filepath>)] block embeds the specified file in the document. ~/samples-durable-functions is an alias for the Durable Functions repo's master branch, so

[!code-csharp[Main](~/samples-durable-functions/samples/csx/E2_BackupSiteContent/run.csx)]

embeds the file located at

https://github.com/Azure/azure-functions-durable-extension/blob/master/samples/csx/E2_BackupSiteContent/run.csx

All the csharp blocks that could map to a sample in the repository should really be file embeds instead, as it helps keep our repository and documentation in sync.

Gotchya I'll do it that way instead, then.

looks like we were just missing one ref to an already-existing 'sample' file. Outside that, the csx snippets weren't refs so I added Precompiled C# ones to the same area. the git push is executing now #hugeRepo ;)

Was this page helpful?
0 / 5 - 0 ratings

Related issues

DeepPuddles picture DeepPuddles  Â·  3Comments

monteledwards picture monteledwards  Â·  3Comments

Agazoth picture Agazoth  Â·  3Comments

spottedmahn picture spottedmahn  Â·  3Comments

jebeld17 picture jebeld17  Â·  3Comments