haskell - Haddock numbered list continuation -

-

how continue numbered list haddock documentation tool? following lines in haddock 

--  1. first line. --  --  2. second line instructions  --  --     >>> command-linecmd param -- --  3. third line.. --

generate next html:

</p><ol><li> first line. </li><li> second line instructions  </li></ol><pre class="screen"><code class="prompt">&gt;&gt;&gt; </code><strong         class="userinput"><code>command-linecmd param </code></strong></pre><ol><li> third line.. </li></ol>

this breaks numbering. there way make haddock continue third-number in html or should try other (>>> gives nice formatting, why i'd use it)?

you can't. you're using >>>. in order have rendered example, needs @ beginning of paragraph.

what's considered beginning of paragraph?

  • anything @ start of haddock comment, skipping white space preceding it.

  • anything following empty line.

in scenario have 4 paragraphs: list element, list element, example, list element. internally, haddock ignores list numbers you're putting down: start 999 if wanted to. when haddock sees consecutive paragraphs same type of list, joins them , numbers them. you're breaking pattern, lists not treated continuation. indenting >>> spaces there pointless in scenario stripped away we're in new paragraph. note spaces important if have consecutive examples: can put them in same paragraph long indentation identical.

other things have on own paragraph (and therefore break list order) lists, birdtracks, codeblocks (paragraph containing text between @s) , properties (prop>).

while solved allowing paragraph nesting, isn't planned. ticket #27 solely nesting lists (which happen paragraph-level entities) not solve problem.

i recommend use unordered lists if numbers aren't vital or cheat bit , use named lists ([name] content)

named , unordered list solutions

edit: of 12 january 2014, haddock ticket #27 has been resolved , possible indenting example 4 spaces after second list element. this:

1. first element  2. second element      >>> example     example result  3. third element

now results in:

haddock nested list items http://fuuzetsu.co.uk/images/1389605057.png


Comments

Post a Comment

Popular posts from this blog

Delphi XE2 Indy10 udp client-server interchange using SendBuffer-ReceiveBuffer -

-
i use delphi xe2 , indy10 udp protocol. can't receive server echo on client side if use receivebuffer method. got "socket error # 10040" although send small echo message server client. console application illustrate problem below. in advance. program project1; {$apptype console} {$r *.res} uses system.sysutils, idglobal, idbasecomponent, idcomponent, idsockethandle, idudpclient, idudpserver, idudpbase, idstack; type tudp_serv = class(tidudpserver) procedure udpsvudpread(athread: tidudplistenerthread; adata: tidbytes; abinding: tidsockethandle); end; var udpserver: tudp_serv; udpcl: tidudpclient; bsnd, brcv: tbytes; s: string; k: integer; //============================================================================== procedure tudp_serv.udpsvudpread(athread: tidudplistenerthread; adata: tidbytes; abinding: tidsockethandle); begin writeln(' server read: ' + tohex(adata, length(adata))); abinding sendto(peerip, peerport, adat...
Read more

Qt ActiveX WMI QAxBase::dynamicCallHelper: ItemIndex(int): No such property in -

-
i new windows programming. here goes code objiwbemlocator = new qaxobject("wbemscripting.swbemlocator"); objwmiservice = objiwbemlocator->querysubobject("connectserver(qstring&,qstring&)",qstring("."),qstring("root\\cimv2")); qaxobject* returnlist = objwmiservice->querysubobject("execquery(qstring&)", qstring("select * %1").arg(domain)); qaxobject* result = returnlist->querysubobject("itemindex(int)", 0); i getting error on runtime qt activex wmi qaxbase::dynamiccallhelper: itemindex(int): no such property in but itemindex method exists msdn says the itemindex method not work collections not contain swbemobjects, such swbemmethodset, swbemnamedvalueset, swbemprivilegeset, swbempropertyset, , swbemqualifierset. what selecting ? have tried iterating on collection ? plus need minimum windows vista itemindex method. hope helps
Read more

Enable autocomplete or intellisense in Atom editor for PHP -

-
i'm first time user of atom editor php code. atom can autocomplete built-in functions of php. possible make editor autocomplete custom function written in separate file? function.php <?php function printsomething() { echo "hello world"; } index.php <?php require_once "function.php"; printsomething(); // autocompleted atom editor while typing thanks in advance. there text file in %userprofile%.atom called snippets.cson. in there can add snippet. more this: http://flight-manual.atom.io/using-atom/sections/snippets/ but need think can use later on other files well. otherwise need copy , paste.
Read more