search

patriksvensson / dotnet-example

A dotnet tool to list and run examples
MIT License
170 stars 15 forks source link

Recognise "eg" (exempli gratia) as an examples folder #2

Closed atifaziz closed 3 years ago

atifaziz commented 3 years ago

This PR allows eg to be recognised as an examples folder, in addition to examples and samples.

Eventually, I think a more flexible option might be needed where a project can declare its examples folder and/or where it can be found rather hardwiring a canned list. I was thinking looking for .examples, which could contain the path to the sub-folder where examples can be found.

patriksvensson commented 3 years ago

@atifaziz Thanks for your contribution.

I can't say that I've seen the folder eg instead of examples/samples much though even if it's technically correct. Perhaps it would be better to support a .examples file like you mention and let the user override the folder name?

atifaziz commented 3 years ago

I can't say that I've seen the folder eg instead of examples/samples much though even if it's technically correct.

I am not surprised at all since I came up with that for my projects and it hasn't caught on. 😉 Somehow, eg aligned better with abbreviations like bin, src, lib, etc, than long-ish albeit clearer names like examples and samples.

Perhaps it would be better to support a .examples file like you mention and let the user override the folder name?

Sure, but something like that could need quite a bit of thinking, design and work, which isn't something I was up to investing right away in terms of time & energy. While I can understand that you can't entertain personal choices, like mine to go with eg, my hope was that you'll find it an acceptable change given that chances for conflict or ambiguity are fairly slim.

patriksvensson commented 3 years ago

Closed due to obsoletion by #5