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

Output formatting #2

Open
martindonat opened this issue Nov 8, 2018 · 5 comments
Open

Output formatting #2

martindonat opened this issue Nov 8, 2018 · 5 comments

Comments

@martindonat
Copy link

Hi,

I run ordodo for the first time and have some minor suggestions, which I will try to implement as a first exercise to get to know the code (and Ruby, I'm a Pythonist).

  • the output filename should include the filename of the config file. Otherwise the file will be overwritten if you use different configs.
  • The std output should state the location of the output file at the end.
  • Maybe a log file would be nice (but I guess Ruby has some module for logging, I think I will leave that as it is).
@igneus
Copy link
Owner

igneus commented Nov 10, 2018

Hi, sorry for the delay - it's better to mention me if you open any further issues. (Tips on how to get notified somehow on new issues even without being mentioned are most welcome. Despite of quite a long history here, I can't call myself Github poweruser.)

the output filename should include the filename of the config file. Otherwise the file will be overwritten if you use different configs.

I'm OK with this. Later there should also be an option to specify the output filename if needed.

The std output should state the location of the output file at the end.

Sounds reasonable.

Maybe a log file would be nice (but I guess Ruby has some module for logging, I think I will leave that as it is).

There is a simple logging solution in the Ruby standard library. And there are, of course, plenty of third-party libraries.
I don't see an urgent need for logging now, but should ordodo one day be widely used for "the real thing", logging would be really useful for remote troubleshooting.

@igneus
Copy link
Owner

igneus commented Nov 10, 2018

Also, before eventually receiving the first pull-request for ordodo ever, I should finally pick a license. I have planned for some time to place this piece of software under the MIT license. Do you like/hate the idea?

@martindonat
Copy link
Author

Puh, finally. Please have a look at my pull-request. Regarding the license: I like the idea of copyleft, but if you want to pick the easier MIT license I would be ok with it.

@igneus
Copy link
Owner

igneus commented Nov 23, 2018

Thanks. MIT license adopted. I will comment on the PR shortly.

@igneus
Copy link
Owner

igneus commented Nov 23, 2018

This need not be handled in the PR in progress, but is related to this issue, so I will note it here rather than there:

I think the "ordodo's main user interface is it's configuration file" philosophy (cf. README) should apply for specifying the output directory, too. It would make sense to support configuring path with placeholder(s), like ordo_{year} or my_custom_ordo_dir_{config_basename}_{year}

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

No branches or pull requests

2 participants