Are we open to PR that improves helptext module?

[wayneyaoo]

Is your feature request related to a problem? Please describe. I'm looking at the IHelpWriter and the default implementation of DefaultHelpWriter. Though the project claims to support "customized helptext", which it does, I found it still a bit cumbersome to implement self-defined helptext writer, mainly because the help writer does not allow configuration via e.g., IHelpWriterConfiguration. If I need to change only a bit of the helptext, I had to copy the whole DefaultHelpWriter and update only a few lines.

Describe the solution you'd like I'm very happy to make the help writer a small but nicely constructed component/module to at least allow configuration. e.g., new lines between sections or not, option alignment etc. The granularity can be discussed but my question is, is such change blessed?

[adambajguz]

Hi @wayneyaoo , to be honest I was also thinking about building new help system but for Typin 4.0 that will be more extensible. Typin 4.0 is currently 'in development' on branch 'feature/generic-host', and new help writer was planned to be a Typin Plugin. Your help will be appreciated!

[wayneyaoo]

Thank you for the confirmation. If I'm about to write code, should I PR to that the "in development" branch?

[adambajguz]

I think we can try implementing from master branch, so it can be released as Typin 3.2 before Typin 4.0. Only data access layer of help will change in Typin 4.0 but help components, sections, headers, etc. should be the same. Please treat IHelpWriter methods as an entry point for new component-based help - not to introduce changes in existing interfaces and only add new.

[wayneyaoo]

I'll come back with a PR :) Thank you.