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

mi6 now searches for pod ... #28

Closed
wants to merge 3 commits into from
Closed

Conversation

holli-holzer
Copy link

not only in ./lib/Module/Name.pm6 but also in ./README.pod6, ./docs/Module/Name.pod6 and ./lib/Module/Name.pod6

@skaji
Copy link
Owner

skaji commented Oct 18, 2017

What motivates you to do this?

@holli-holzer
Copy link
Author

I want to make something I want to use better. Why are you asking?

@skaji
Copy link
Owner

skaji commented Oct 18, 2017

If you want to change a file that generates README.md, then you can use dist.ini.
So I don't think mi6 needs to change current behavior.

@holli-holzer
Copy link
Author

The current behaviour surprised me and probably more importantly, the experienced zoffixnet. Especially since the program doesnt warn if it finds nothing and silently overwrite the - maybe (cough) hand written - readme. What's wrong with letting the program look in all the usual places?

@skaji
Copy link
Owner

skaji commented Oct 19, 2017

Thank you for explaining your motivation.

I don't think mi6 should search other files to generate README.md.
But, yeah, it could be nice emitting warnings when the main module file does not contain pod.

@holli-holzer
Copy link
Author

https://irclog.perlgeek.de/perl6/2017-10-19#i_15324549

Arguments from authority suck, I know. Look, my change is well written, valueable and doesn't break anything. I don't understand why you are so reluctant. But fine, i will then just keep using Ddt.

@GeJ
Copy link

GeJ commented Oct 19, 2017

Beauty is in the eye of the beholder. Your coding style doesn't match the one of the author.
Also if I understand correctly this change will pick any existing 'README.pod6' over a file explicitly defined in dist.ini which looks like a POLA violation. The .subst('lib', 'docs') looks fragile and, while convoluted as it's the last possible choice in the list, one could think of a case where a file defined in dist.ini doesn't reside in 'lib/' but still has a "lib" sub-string in its name. Best case the resulting file doesn't exist, worst case it picks a totally unrelated file.
And finally, I like the minimalist approach of mi6 with a simple behavior based on simple conventions and that it doesn't try too hard to do everything for everyone. In that regard ddt looks like an awesome tool that could easily be extended for custom workflows. But they clearly aim for different users with different needs.
Just sayin'

@holli-holzer
Copy link
Author

holli-holzer commented Oct 19, 2017 via email

@skaji skaji closed this Oct 27, 2018
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

Successfully merging this pull request may close these issues.

None yet

3 participants