Change order of technical description and list of functions in documentation
See original GitHub issueThree 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:
- Created 2 years ago
- Reactions:3
- Comments:7 (5 by maintainers)
Top 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 >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
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 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.