Undocumented exception(s) in the Num module
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Documentazione
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Stack tecnologico
- ocaml
- Ambito
- documentation
Direzione di ricerca
Start with the Num module exposed by nums.cma, focusing first on Num.power_num and its Invalid_argument behavior. Review the module's existing documentation and identify undocumented functions, exceptions, and conditions that can raise them. Done means the relevant Num functions and failure conditions are documented, including the power_num limitation described in the report.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Original bug ID: 7065
Reporter: SpiceGuid
Status: acknowledged (set by @gasche on 2015-11-28T20:19:38Z)
Resolution: open
Priority: low
Severity: feature
Target version: later
Category: documentation
Bug description
Some people assume they can compute square root or cubic root by providing
a 1/2 or 1/3 ratio argument to the Num.power_num function.
Unfortunately they can't :
# #load "nums.cma";;
# open Num;;
# int_of_num (Int 27 **/ (Int 1 // Int 3));;
Exception: Invalid_argument "power_num".
The problem is not they can't, the problem is they assume they can and are encouraged by the silent documentation to do so.
I suggest that all Num functions should be totally documented, including exceptions and conditions that can raise them.
- Lingua principale
- OCaml
- Stelle
- 39
- Fork
- 29
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di ocaml/num
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 45/100
-
feature wish
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
Issue simili
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
kentcdodds/kcd-skills#32 ·
-
source-control: ExitWorktree remove no longer deletes another running session's worktree (2.1.330)Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
melodic-software/claude-code-plugins#17829 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno
-
sync-en
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
I maintainer di solito rispondono entro 1 giorno
-
The structured output reference promises null results for refusals that carry validation detailsApertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
I maintainer di solito rispondono entro 1 giorno