Skip to content

Commit

Permalink
Merge pull request #28 from 10Pines/add-documentation
Browse files Browse the repository at this point in the history
Add documentation
  • Loading branch information
JuanFdS authored Mar 28, 2021
2 parents b9dc21c + a521e54 commit 3fc3a15
Show file tree
Hide file tree
Showing 6 changed files with 580 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,3 +237,7 @@ También, se pueden correr los tests usando:
```bash
stack test
```

### Guía para el desarrollador para documentar las funciones

Para documentar cualquiera de las funciones utilizamos [Haddock](https://haskell-haddock.readthedocs.io/en/latest/markup.html)
2 changes: 2 additions & 0 deletions hie.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
cradle:
stack:
8 changes: 8 additions & 0 deletions src/PdePreludat.hs
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,22 @@ ifThenElse condition ifTrue ifFalse = case condition of
-- Valor pensado para usarla como implementación por defecto de funciones
-- o valores que pidamos que sean implementados en los ejercicios

-- | Se puede usar en vez de una expresión que aun no se implementó.
-- Tipa en cualquier lugar que se use pero al evaluarlo falla con un error de "Falta implementar."
(...) :: a
(...) = P.error "Falta implementar."

-- Aliases utiles

-- | Se puede usar en vez de una expresión que aun no se implementó.
-- Tipa en cualquier lugar que se use pero al evaluarlo falla con un error de "Falta implementar."
-- Alias de (...)
implementame :: a
implementame = (...)

-- | Se puede usar en vez de una expresión que aun no se implementó.
-- Tipa en cualquier lugar que se use pero al evaluarlo falla con un error de "Falta implementar."
-- Alias de (...)
arreglame :: a
arreglame = (...)

Expand Down
Loading

0 comments on commit 3fc3a15

Please sign in to comment.