Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

the structure of directories is not clear #565

Open
yegor256 opened this issue Nov 26, 2024 · 5 comments
Open

the structure of directories is not clear #565

yegor256 opened this issue Nov 26, 2024 · 5 comments

Comments

@yegor256
Copy link
Member

It would be very helpful if you explain the entire tree of the directory in this file: https://github.com/objectionary/eo-phi-normalizer/blob/master/eo-phi-normalizer/README.md As it looks now, the are not conventions in Haskell world (or I don't know them), which would be obviously followed in this repo. It's hard to understand the meaning, for example, of test/Test directory (why "test" twice?).

@yegor256
Copy link
Member Author

@deemp please, check

@deemp
Copy link
Member

deemp commented Nov 26, 2024

@yegor256, the package.yaml and eo-phi-normalizer.cabal pretty much describe which directories contain files for which parts of the Haskell project.

The structure of package.yaml is documented here.

The structure of a *.cabal file is documented here.

@yegor256
Copy link
Member Author

@deemp looks good, but where can I find information about the test/Test directory?

@deemp
Copy link
Member

deemp commented Nov 26, 2024

@yegor256, as follows from package.yaml, the test directory contains test modules.

The modules from src and test may be imported in the test modules.

The modules must start with a capital letter (https://en.wikibooks.org/wiki/Haskell/Modules) and their names are mapped to paths to these modules.

We decided to group some modules under Test.

Here's how we import one of these modules:

import Test.Metrics.Phi (MetricsTest (..), MetricsTestSet (..))

@yegor256
Copy link
Member Author

@deemp maybe at least a quick intro you can add to the README? Now the project looks very "cold" to a stranger. Of course, a qualified Haskell developer will figure everything out, but others...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants