Comments (4)
That's a good point, @frtibble, thanks for raising the issue. At the moment, we don't have a great way to document which package contributes a given operation or function; especially for those namespaces like Microsoft.Quantum.Arithmetic
, Microsoft.Quantum.Math
, and Microsoft.Quantum.Convert
that are split across packages, it would be good if we could document that similarly to how C# API docs list which assembly contributes a given type. I like the idea of providing better links from namespace descriptions in the meantime, though, as a workaround.
+@bromeg, @natke, and @v-stgr for discussion.
from quantum-docs-pr.
Yes, I agree - your first suggestion would be the clearest, I think, and it'd make the most sense given that's how it's documented in C#. Thanks for considering my suggestion too.
from quantum-docs-pr.
It sounds like we need to document the dependencies between packages?
Is there a one to one correspondence between package and namespace, or not?
from quantum-docs-pr.
There's not generally a one-to-one mapping between namespaces and packages, unfortunately. They are pretty correlated, but there's also namespaces like Microsoft.Quantum.Math
and Microsoft.Quantum.Diagnostics
that get split across packages for various technical reasons. For the most part, if a user uses the new SDK package, then they should be OK to use everything in the references except for domain-specific functionality brought in from Microsoft.Quantum.Chemistry.*, Microsoft.Quantum.Numerics, Microsoft.Quantum.Research, and Microsoft.Quantum.MachineLearning.
from quantum-docs-pr.
Related Issues (20)
- Wrong Q# sequence in MeasureY HOT 2
- Troubles with using Length(Qubit[]) function in Jupyter Notebook HOT 2
- [Broken link] the quickstart-guide link needs to be fixed HOT 1
- No documentation available for "within/apply" statements. HOT 3
- There is no way to download the documents HOT 1
- Empty Tuple Code Sample in Entanglement Tutorial HOT 3
- Lenny-QC HOT 1
- `import qsharp` fails or takes too long time HOT 2
- Add a link to the Q# language design repo HOT 1
- Code sample for LocalRotationsLayer? HOT 2
- Add qsharp-language to repo list HOT 1
- Instructions for creating a new Q# project in VS Code are not clear HOT 1
- Z gate error HOT 4
- typo in PE without eigenstates HOT 4
- VS Code and VS Studio Icons/Titles are mixed up. HOT 1
- "This Page" feedback button directs to wrong repo HOT 7
- Examples from Q# Libraries API don't show up in docs HOT 2
- LaTeX formulas won't render in the PDF version HOT 1
- Link HOT 1
- IQ# magic commands don't have a list page HOT 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from quantum-docs-pr.