microsoft / qsharp-runtime

Runtime components for Q#
https://docs.microsoft.com/quantum
MIT License
286 stars 93 forks source link

@Deprecated tag doesn't handle code snippet arguments #843

Open tcNickolas opened 3 years ago

tcNickolas commented 3 years ago

Looking at the source of this page https://github.com/microsoft/QuantumLibraries/blob/8352240cf512dc46824f38354102282bd7925cf7/Standard/src/Arithmetic/Deprecated.qs#L143 The argument to @Deprecated is not a fully qualified operation name but rather a code snippet, but the documentation attempts to treat it as an operation name by appending xref: to it. It would be nice if the documentation generator could distinguish this scenario (maybe by presence of characters other than letters and dots?) and generate a better "use instead" suggestion.


Document Details

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

cgranade commented 3 years ago

Thanks for filing this, @tcNickolas. The @Deprecated attribute is defined in the packages built from the qsharp-runtime repo, so I'll go on and transfer the issue there.