haskell - How are the Haddock module fields Portability, Stability and Maintainer used? -

-


haskell - How are the Haddock module fields Portability, Stability and Maintainer used? -

in lots of haddock-generated module documentation (e.g. prelude), little box in top-right can seen, containing portability, stability , maintainer information:

from looking @ source code such modules , experimentation, confirmed info generated lines next in module description:

-- maintainer : libraries@haskell.org -- stability : stable -- portability : portable

there several unusual things this:

the fields only seem work in order — fields set out of order treat part of module description itself. despite fact order in source file opposite of order in generated documentation!

i have been unable find official documentation of these fields. there cabal bundle property named stability, illustration values of match values i've seen in equivalent haddock fields, beyond that, i've found nothing.

so: how these fields intended used, , documented anywhere?

in particular, i'd know:

the total list of commonly-used values portability , stability. this haskellwiki page has list, i'd know list originated from.

the criteria deciding whether module portable or non-portable. in particular, bundle answers these questions for, acme-strfry, ffi binding strfry, function available in glibc. bundle non-portable, because works on glibc systems, or portable, because not utilize haskell language extensions? mutual usage seems imply latter.

why specific order of fields required in source file, , why it's opposite of ordering in generated documentation.

oh, thought fields cabal bundle description. don't seem documented @ on haddock's docs. i've found this, doesn't reply question but:

http://trac.haskell.org/haddock/ticket/71

so if it's freeform anyway, why not write "non-portable (depends on glibc)"? i've seen "portable (depends on ghc)", odd. wonder happens modules non-portable due non-haskell98 extension foo, after foo added haskell 2010.

note cabal documenation link says stability freeform. of course, if haddock or cabal define acceptable values, it'd still maintainer subjectively select one.

about specific order, should inquire @ haddock mailing list, or check source , file bug.

ps: strfry invaluable contribution haskell community, should pure , portable, don't think?

haskell haddock

Comments

Post a Comment

Popular posts from this blog

delphi - blogger via idHTTP : error 400 bad request -

-
delphi - blogger via idHTTP : error 400 bad request - i'm trying post blogger using idhttp component, however, i'm getting "http/1.0 400 bad request" error. procedure tform1.button1click(sender: tobject); var request,response,req : tstringlist; auth,blogid : string; begin blogid := '00000000000000000000000'; request := tstringlist.create; response := tstringlist.create; req := tstringlist.create; idhttp1.request.connection := 'keep-alive'; idhttp1.request.contenttype := 'application/x-www-form-urlencoded'; idssliohandlersocket1.ssloptions.method := sslvsslv23; request.clear(); request.values['accounttype'] := 'google'; request.values['email'] := 'xxx@gmail.com'; request.values['passwd'] := 'yyy'; request.values['service'] := 'blogger'; response.text :=idhttp1.post('https://www.google.com/accounts/clientlogin',request); auth := resp...
Read more

c++ - compiler errors when initializing EXPECT_CALL with function which has program_options::variables_map as parameter -

-
c++ - compiler errors when initializing EXPECT_CALL with function which has program_options::variables_map as parameter - i'm having problem expect_call method, when trying : boost::program_options::variables_map vm; mymock mock; expect_call(mock, mymethod(vm)).willonce(return(l"")); mymethod looks : std::wstring mymethod(const boost::program_options::variables_map &vm) when compiling got errors : error 17 error c2676: binary '==' : 'const boost::program_options::variable_value' not define operator or conversion type acceptable predefined operator c:\program files (x86)\microsoft visual studio 9.0\vc\include\utility error 10 error c2784: 'bool std::operator ==(const _elem *,const std::basic_string<_elem,_traits,_alloc> &)' : not deduce template argument 'const _elem *' 'const boost::program_options::variable_value' c:\program files (x86)\microsoft visual studio 9.0\vc\include\u...
Read more

How do I check if an insert was successful with MySQLdb in Python? -

-
How do I check if an insert was successful with MySQLdb in Python? - i have code: cursor = conn.cursor() cursor.execute(("insert new_files (videos_id, filename, " "is_processing) values (%s,%s,1)"), (id, filename)) logging.warn("%d", cursor.rowcount) if (cursor.rowcount == 1): logging.info("inserted values %d, %s", id, filename) else: logging.warn("failed insert values %d, %s", id, filename) cursor.close() fun is, cursor.rowcount always one, though updated database create videos_id unique key. is, insert fails because in tests same videos_id going appear (and when check database, nil inserted). whatever reason, rowcount 1 - logging.warn have spits out rowcount of 1. so, question: can utilize rowcount work out if insert went fine? if so, (presumably) doing wrong? otherwise, how check if insert went fine? your code not commit after modifications (your modifications rolled back). should...
Read more