Azure / Azure/azure-functions-core-tools
Update documentation on debugging apps
- Dominant language
- C#
- Stars
- 1.5k
- Forks
- 498
- Avg merge
- 4d 20h
- Merged PRs (30d)
- 14
Description
The [current wiki page](https://github.com/Azure/azure-functions-core-tools/wiki/Enable-Debugging-for-language-workers) has sections that are limited and/or outdated, and it is linked from an official doc describing the `--language-worker` property [here](https://learn.microsoft.com/en-us/azure/azure-functions/functions-core-tools-reference?tabs=v2#func-start).
Users should use the official docs for local development such as [this](https://learn.microsoft.com/en-us/azure/azure-functions/functions-develop-local?pivots=programming-language-csharp) instead.
Removal of the wiki page may require scoping out how many users use this method first. If documentation is removed, there should be a discussion about deprecating `--language-worker` since this wiki page appears to be the only written description of its function and usage.
Contributor guide
Research direction
Start with the linked wiki page and the official local-development and Core Tools reference pages, especially the func start entry point and --language-worker property. Determine how widely this debugging method is used and whether the wiki should be removed; document the decision and any discussion needed about deprecating --language-worker.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100