Skip to content
This repository was archived by the owner on Nov 13, 2024. It is now read-only.

Keywords/language reference pages #1040

Closed
wants to merge 19 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions articles/user-guide/language-ref/attributes/entrypoint-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: '@EntryPoint'
description: Keyword reference '@EntryPoint'
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.entrypoint
---

# `@EntryPoint`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and @Test are both attributes that are already documented in the API reference; can we link to those from the TOC rather than duplicating that content?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cgranade That's a great point, thanks. Just to clarify, it sounds like you mean keeping the links in the TOC dropdown (and the keyword list page), but simply linking direct to the API page?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that should work, yeah. If I recall, you can make href properties in toc.yml point to xrefs instead of Markdown file paths; that would allow for reusing the automatically generated references for Test and EntryPoint.


fill


https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/5_Attributes.md#attributes
16 changes: 16 additions & 0 deletions articles/user-guide/language-ref/attributes/test-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: '@Test'
description: Keyword reference '@Test'
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.test
---

# `@Test`

fill


https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/5_Attributes.md#attributes
15 changes: 15 additions & 0 deletions articles/user-guide/language-ref/binding-assignment/let-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: let
description: Keyword reference let
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.let
---

# `let`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/2_Statements/VariableDeclarationsAndReassignments.md#variable-declarations-and-reassignments
15 changes: 15 additions & 0 deletions articles/user-guide/language-ref/binding-assignment/mutable-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: mutable
description: Keyword reference mutable
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.mutable
---

# `mutable`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/2_Statements/VariableDeclarationsAndReassignments.md#variable-declarations-and-reassignments
13 changes: 13 additions & 0 deletions articles/user-guide/language-ref/binding-assignment/new-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: new
description: Keyword reference new
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.new
---

# `new`

fill
15 changes: 15 additions & 0 deletions articles/user-guide/language-ref/binding-assignment/set-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: set
description: Keyword reference set
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.set
---

# `set`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/2_Statements/VariableDeclarationsAndReassignments.md#variable-declarations-and-reassignments
15 changes: 15 additions & 0 deletions articles/user-guide/language-ref/callables/functors/adjoint-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Adjoint
description: Keyword reference Adjoint
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.adjoint
---

# `Adjoint`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/3_Expressions/FunctorApplication.md#functor-application
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Controlled Adjoint
description: Keyword reference Controlled Adjoint
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.controlled-adjoint
---

# `Controlled Adjoint`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/3_Expressions/FunctorApplication.md#functor-application
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Controlled
description: Keyword reference Controlled
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.controlled
---

# `Controlled`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/3_Expressions/FunctorApplication.md#functor-application
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: auto
description: Keyword reference auto
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.auto
---

# `auto`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: distribute
description: Keyword reference distribute
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.distribute
---

# `distribute`

fillhttps://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: intrinsic
description: Keyword reference intrinsic
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.intrinsic
---

# `intrinsic`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: invert
description: Keyword reference invert
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.invert
---

# `invert`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: self
description: Keyword reference self
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.self
---

# `self`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: adjoint (Specialization Tag)
description: Keyword reference (specialization tag) adjoint
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.adjoint-tag
---

# `adjoint` (Specialization Tag)

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: body (Specialization Tag)
description: Keyword reference (specialization tag) body
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.body-tag
---

# `body` (Specialization Tag)

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/3_CallableDeclarations.md#callable-declarations

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: controlled adjoint (Specialization Tag)
description: Keyword reference (specialization tag) controlled adjoint
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.controlled-adjoint-tag
---

# `controlled adjoint` (Specialization Tag)

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: controlled (Specialization Tag)
description: Keyword reference (specialization tag) controlled
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.controlled-tag
---

# `controlled` (Specialization Tag)

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/1_ProgramStructure/4_SpecializationDeclarations.md#specialization-declarations
20 changes: 20 additions & 0 deletions articles/user-guide/language-ref/callables/partial-app-symb-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: '_ (partial application)'
description: 'Keyword reference _ partial application symbol'
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.partial-app-symb
---

# `_` (partial application)

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/3_Expressions/PartialApplication.md#partial-application



*Alternative use*: accessing only part of a deconstructed/unwrapped tuple.
https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/3_Expressions/ItemAccessExpressions.md#item-access-for-user-defined-types
15 changes: 15 additions & 0 deletions articles/user-guide/language-ref/callables/return-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: return
description: Keyword reference return
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.return
---

# `return`

fill

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/2_Statements/ReturnsAndTermination.md#return-statement
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: 'is Adj + Ctl'
description: Keyword reference 'Adj + Ctl'
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.adj-ctl
---

# `is Adj + Ctl`

Equivalent to `is Ctl + Adj`.

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/4_TypeSystem/OperationsAndFunctions.md#operation-characteristics
13 changes: 13 additions & 0 deletions articles/user-guide/language-ref/callables/signature/adj-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: is Adj
description: Keyword reference Adj
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.adj
---

# `is Adj`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/4_TypeSystem/OperationsAndFunctions.md#operation-characteristics
13 changes: 13 additions & 0 deletions articles/user-guide/language-ref/callables/signature/ctl-ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: is Ctl
description: Keyword reference Ctl
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.ctl
---

# `is Ctl`

https://github.com/microsoft/qsharp-language/blob/main/Specifications/Language/4_TypeSystem/OperationsAndFunctions.md#operation-characteristics
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: '-> (Function Signature)'
description: 'Keyword reference -> function signature symbol'
author: gillenhaalb
ms.author: a-gibec
ms.date: 05/09/2020
ms.topic: article
uid: microsoft.quantum.lang-ref.fn-signature-symb
---

# `->` (Function Signature)

fill
Loading