Revision d30736267c82518348bf88cf190657a12b9905e1 (click the page title to view the current version)

doctesting

Changes from d30736267c82518348bf88cf190657a12b9905e1 to current

Some recently written functions whose documentation needs to be proofread (see src/functions/ subdirectories)

- check short documentation (?fun) for clarity / correction / brevity

- check detailed description (??fun) for clarity / correction / completeness
  and missing / confusing / non-working examples.

- also check the function [online translation](http://pari.math.u-bordeaux.fr/dochtml/html/)

Add you name next to the function if you're checking it. Either leave your
comments here or (preferred) edit the documentation in src/functions/*/fun
and send a patch

# Reference cards
- refcard
- refcard [Paul]
- refcard-ell
- refcard-lfun
- refcard-mf
- refcard-nf

# Modular Forms
- getcache         
- lfunmf         
- mfDelta           
- mfEH
- mfEk             
- getcache (Thomas)        
- lfunmf (Thomas)        
- mfDelta (Thomas)          
- mfEH (Thomas)
- mfEk (Thomas)            
- mfTheta        
- mfatkin           
- mfatkineigenvalues
- mfatkininit      
- mfbasis        
- mfbd              
- mfbracket
- mfcoef           
- mfcoefs        
- mfconductor       
- mfcosets
- mfcuspisregular  
- mfcusps        
- mfcuspval         
- mfcuspwidth
- mfderiv          
- mfderivE2      
- mfdescribe        
- mfdim
- mfdiv            
- mfeigenbasis   
- mfeigensearch     
- mfeisenstein
- mfembed          
- mfeval         
- mffields          
- mffromell
- mffrometaquo     
- mffromlfun     
- mffromqf          
- mfgaloistype
- mfgaloisprojrep
- mfhecke          
- mfheckemat     
- mfinit            
- mfisCM
- mfisequal        
- mfkohnenbasis  
- mfkohnenbijection 
- mfkohneneigenbasis
- mflinear         
- mfmanin        
- mfmul             
- mfnumcusps        
- mfparams         
- mfperiodpol    
- mfperiodpolbasis  
- mfpetersson       
- mfpow            
- mfsearch       
- mfshift           
- mfshimura         
- mfslashexpansion 
- mfspace        
- mfsplit           
- mfsturm           
- mfsymbol         
- mfsymboleval   
- mftaylor          
- mftobasis
- mftocoset        
- mftonew        
- mftraceform       
- mftwist  

# L-functions

- lfunartin
- lfuncost
- lfunthetacost
- lfungenus2
- lfuntwist
- hyperellpadicfrobenius
- hyperellcharpoly

# Elliptic curves / Hyperelliptic curves
- ellbsd
- ellminimaldisc
- ellpadicbsd
- ellpadicregulator (Gautier, comment: it is not clear (at least to me) what is $S$ in the short help, also, apparently dollar signs in the short help should be remove)
- ellratpoints 
- elltamagawa
- ellweilcurve
- hyperellratpoints

# Modular symbols
- msatkinlehner
- mscuspidal
- msdim (Gautier)
- mseisenstein
- mseval
- msfromcusp
- msfromell
- msfromhecke
- msgetlevel
- msgetsign
- msgetweight
- mshecke
- msinit (Gautier, comment: would require a simple example such as "M = msinit(11,2); \\ M2(Gamma0(11))" and "M = msinit(11,2, 1); \\ M2(Gamma0(11))^+")
- msissymbol
- mslattice
- msnew
- mspathgens
- mspathlog
- mspetersson
- mspolygon
- msqexpansion
- mssplit
- msstar

# Number fields
- bestapprnf (Penguin)
- nfeltsign (Penguin)
- nfeltembed (Penguin)
- poldiscfactors (Penguin)

# Dirichlet characters
- chargalois
- charpow
- znchar
- znchardecompose
- zncharconductor
- znchargauss
- znchartoprimitive

# GP
- fordivfactored
- forfactored
- forperm
- forsquarefree
- forsubset
- vecprod
# GP [Julien]
- fordivfactored - ok
- forfactored - ok
- forperm - ok
- forsquarefree - ok
- forsubset - ok
- vecprod - ok

# Summations
- prodeulerrat
- prodnumrat
- sumaltrat
- sumeulerrat
- sumnulagrangeinit
- sumnumap
- sumnumapinit
- sumnumlagrange
- sumnumrat
# Summations [Marine]
- asympnum --> phénomène étrange signalé à Henri
- limitnum - ok
- prodeulerrat - ok
- prodnumrat - ok
- sumeulerrat - ok
- sumnulagrangeinit - ok
- sumnumap - ok
- sumnumapinit - ok
- sumnumlagrange - ok
- sumnumrat - ok

# Finite Fields
- ffembed
- ffmap
- ffinvmap
- ffcompomap
- ffextend
- fffrobenius
# Transcendental functions [Marine] - ok
- airy
- dirpowers
- hypergeom

# Elementary number theory
# Polynomials [Marine] - ok
- polteichmuller
- polhermite
- pollaguerre
- pollegendre

- divisorslenstra
- ecpp
- ecppexport
- ecppisvalid.
# Elementary number theory [Marine] - ok

# Linear algebra
- isprime
- primecert
- primecertexport
- primecertisvalid
- factor
- qfbsolve
- kronecker 
- Mod

- matdetmod
- matimagemod
- matinvmod
- matkermod
# Manipulation of character strings
- strchr [KB: DONE]
    - Doc: I think it should be noted in the doc string, that it only works for numbers between 1 and 255 (inclusive). 
- strexpand [KB: DONE]
    - Help: "concatenates its (string) argument" - Plural form should be used, "its (string) arguments"
    - Example: The example only features the environment variable expansion, but lacks concatenation. In my opinion, a new example should be added, highlighting multiple arguments.
- strjoin [KB: DONE]
    - Example: The output of the actual strjoin function is not part of the example. The usage of strsplit in the example is completely unnecessary, v = ["abc", "def", "ghi"] would be completely sufficient. 
- strprintf [KB: DONE]
    - Example: No example given. I think there should be a small example highlighting the usage, even though there are examples on the printf page.
- strsplit  [KB: DONE]
    - Doc: The doc string is not correct, "into a vector" appears twice.
- strtex [KB: DONE]
    - Example: No example given. Maybe something like this would be okay:

            ? v = [1, 2, 3]
            %1 [1, 2, 3]
            ? strtex(v)
            %2 = "\\pmatrix{ 1&2&3\\cr}\n"

# Miscellaneous

- alggroupcenter
- algmakeintegral (Paul)
- exponent (Paul)
- galoischardet (Paul)
- galoischarpoly (Paul)
- galoischartable (Paul)
- galoisconjclasses (Paul)
- laurentseries (Paul)
- matpermanent (Paul)
- permorder (Paul)
- permsign (Paul)
- polrootsbound (Paul)
- printp (Paul)
- serprec (Paul)
- zetahurwitz (Paul)
- zetamultall (Paul)
- zetamultconvert (Paul)
- zetamultinit (Paul)
# Miscellaneous
- export
- exportall
- getlocalprec
- getlocalbitprec
- localprec
- localbitprec
- unexport
- unexportall