doctesting

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

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 [Paul]
  • refcard-ell
  • refcard-lfun
  • refcard-mf
  • refcard-nf

Modular Forms

  • 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
  • ellratpoints
  • elltamagawa
  • ellweilcurve
  • hyperellratpoints

Modular symbols

  • msatkinlehner
  • mscuspidal
  • mseisenstein
  • mseval
  • msfromcusp
  • msfromell
  • msfromhecke
  • msgetlevel
  • msgetsign
  • msgetweight
  • mshecke
  • msissymbol
  • mslattice
  • msnew
  • mspathgens
  • mspathlog
  • mspetersson
  • mspolygon
  • msqexpansion
  • mssplit
  • msstar

Dirichlet characters

GP [Julien]

  • fordivfactored - ok
  • forfactored - ok
  • forperm - ok
  • forsquarefree - ok
  • forsubset - ok
  • vecprod - ok

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

Transcendental functions [Marine] - ok

  • airy
  • dirpowers
  • hypergeom

Polynomials [Marine] - ok

  • polteichmuller
  • polhermite
  • pollaguerre
  • pollegendre

Elementary number theory [Marine] - ok

  • isprime
  • primecert
  • primecertexport
  • primecertisvalid
  • factor
  • qfbsolve
  • kronecker
  • Mod

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

  • export
  • exportall
  • getlocalprec
  • getlocalbitprec
  • localprec
  • localbitprec
  • unexport
  • unexportall