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

Add separate examples directory #9287

Open
createyourpersonalaccount opened this issue Nov 25, 2023 · 2 comments
Open

Add separate examples directory #9287

createyourpersonalaccount opened this issue Nov 25, 2023 · 2 comments
Labels
docs Documentation improvements

Comments

@createyourpersonalaccount

Desired Behavior

The example directory contains cram tests and is not very intuitive for beginners.

I have the following examples in mind that I would like to contribute to Dune: https://github.com/createyourpersonalaccount/dune_examples but cram tests get in the way in my opinion.

See also #9163 (comment) and the responses for some background on this suggestion.

Example

Under the example directory, there could be the cram-examples directory. But there should also be other examples, such as the ones I linked above in my repository.

@createyourpersonalaccount
Copy link
Author

@Alizter Ping on this, you can see the two examples that I had in mind at https://github.com/createyourpersonalaccount/dune_examples

@Alizter
Copy link
Collaborator

Alizter commented Nov 29, 2023

Hi, we discussed this in the dev meeting today. We are open to adding new examples in the way you described. Our first priority would be to take the feedback on cram tests and write some better documentation.

https://github.com/ocaml/dune/wiki/dev-meeting-20231129#examples-directory-alizter

@Alizter Alizter added the docs Documentation improvements label Dec 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

No branches or pull requests

2 participants