question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Change order of technical description and list of functions in documentation

See original GitHub issue

Three modules, kernels, grouping, and qaoa have their module documentation ordered such that there is first a lengthy description of the theory, and the actual list of functions comes after. We should update the docs of these modules so that the functions appear first, and the technical details come afterwards (as was recently discussed in #1160). This will improve readability of the documentation and make it easier to find the details of a desired function.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:3
  • Comments:7 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
n45800commented, Aug 17, 2021

Hi , Akash yes you can work, unfortunately i am too busy these days to do the update

On Mon, Aug 16, 2021 at 11:48 PM Olivia Di Matteo @.***> wrote:

@AkashNarayanan https://github.com/AkashNarayanan for sure, but perhaps we should check in first with @n45800 https://github.com/n45800 to make sure there is not a PR in the works that will be posted soon.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/PennyLaneAI/pennylane/issues/1365#issuecomment-899840285, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB7QE427RU7J2EVP4HFLUWDT5GBUFANCNFSM45UGX26Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&utm_campaign=notification-email .

1reaction
glassnotescommented, Aug 16, 2021

@AkashNarayanan for sure, but perhaps we should check in first with @n45800 to see whether there is a PR in the works that will be posted soon.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Technical Description: What is it & How to Write it? (Steps ...
A technical description typically includes the names of the product or process, gives a brief overview regarding its functions, and dives deep into...
Read more >
Technical Documentation in Software Development - AltexSoft
In general, product documentation includes requirements, tech specifications, business logic, and manuals. There are two main types of product ...
Read more >
7.4 Technical Descriptions and Definitions
Descriptions can range from a brief sentence, to a paragraph, a whole section of a report, or an entire manual. Poorly written technical...
Read more >
Writing a Technical Description: Best Practices - ClickHelp
Use a Plan​​ Technical descriptions can be diverse: they describe different objects, serve different purposes, are created for different ...
Read more >
What Is a Technical Description? (Plus Template and Example)
A technical description is defining how an individual can use a product or complete a task following a sequential order.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found