[16.0][IMP] contract documentation#1398
Open
victor-champonnois wants to merge 1 commit intoOCA:16.0from
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
EDIT : Help welcome to make pre-commit pass. The precommit in the CI throws an error
ModuleNotFoundError: No module named 'pkg_resources'I've been using the contract module quite intensively in the past year, and I wanted to contribute by improving the documentation. I have only a user knowledge of this module, please don't hesitate to point out any mistake I made.
I also should say that I've used mostly Customer contracts. Maybe there are some specific features in Supplier contracts that I missed.
Here are the changes I've made :
I realized afterwards I should have made the markdown conversion in a separate commit. However I doubt there will be a lot of issues there since the rst was quite basic.
I've used mostly the v16 version. If these changes is approved and if there hasn't been major changes in v18, I will port to v18.