-
Notifications
You must be signed in to change notification settings - Fork 26
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
Create USAGE.rst #346
Create USAGE.rst #346
Conversation
Codecov Report
@@ Coverage Diff @@
## 12.0 #346 +/- ##
=======================================
Coverage 56.58% 56.58%
=======================================
Files 97 97
Lines 3524 3524
Branches 560 560
=======================================
Hits 1994 1994
Misses 1451 1451
Partials 79 79 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
cooperator/readme/USAGE.rst
Outdated
@@ -0,0 +1,8 @@ | |||
A localization module is needed with this module. | |||
|
|||
The following localization modules are available this repository: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following localization modules are available this repository: | |
The following localization modules are available in this repository: |
cooperator/readme/USAGE.rst
Outdated
@@ -0,0 +1,8 @@ | |||
A localization module is needed with this module. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens when none is installed ? Do we get a nice error ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, there is no error.
Actually, this is part to the configuration of cooperator that is explained in the functional documentation. Since the documentation is linked in the readme, maybe this Usage file is not required. Or we could just make a usage file that points to the documentation ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed :
- a link to the documentation is 👍
- mentioning that localization is needed is nice
- better solution is to make localization modules
auto_install
ed
todo (following discussion with @robinkeunen):
|
Done |
@@ -35,4 +35,5 @@ | |||
], | |||
"installable": True, | |||
"application": False, | |||
"auto-install": True, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is cooperator_website
needed in the depends here ? If so, the localization will only be installed if all 4 modules are installed.
Besides the auto_install feature, it also means we can't install the localization without installing cooperator_website.
Same story for other localizations.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
En passant, l10n_be_invoice_bba
is empty in v14 so we can skip that dependency there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
cooperator_website
needed in the depends here ? If so, the localization will only be installed if all 4 modules are installed.Besides the auto_install feature, it also means we can't install the localization without installing cooperator_website.
Same story for other localizations.
Yes it is needed because the module overload the subscription form template. I don't see a way around this now, maybe cooperator_website should also be auto-install ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
En passant,
l10n_be_invoice_bba
is empty in v14 so we can skip that dependency there.
Noted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok then I think you should add in known_caveats of ROADMAP.rst
that this module will have to be split if someone needs to install one module without the other.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
PR forward ported here : #368 |
/ocabot merge minor |
On my way to merge this fine PR! |
It looks like something changed on |
It looks like something changed on |
@robinkeunen The merge process could not be finalized, because command
|
f0d71d1
to
5b63655
Compare
5b63655
to
425d9a5
Compare
/ocabot merge minor |
On my way to merge this fine PR! |
Congratulations, your PR was merged at 71ca25b. Thanks a lot for contributing to coopiteasy. ❤️ |
I know localization are needed for cooperator_website, is it also the case for cooperator ?