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

[FW]Various documentation fixes resulting from onboarding #57580

Closed

Conversation

fw-bot
Copy link
Contributor

@fw-bot fw-bot commented Sep 11, 2020

See the commit messages for detailed descriptions of the different issues.

Removing the link to the Javascript API document results in a warning when building because it doesn't have a parent anymore. But I'm ok with that, since I hope that the underlying compatibility issue will be fixed one day and the link can be restored. And it serves as a reminder that something is broken.

I created a static folder for the truncated csv file included in the documentation. Let me know if a different location is more appropriate.

I expect there might be a merge conflict in 13.0 regarding the inherit_id and mode fields, because that section of the documentation was restructured there.

Here's an example of the bullet list formatting issues:
Screenshot from 2020-09-08 14-24-32

Forward-Port-Of: #57270

@robodoo robodoo added conflict There was an error while creating this forward-port PR forwardport This PR was created by @fw-bot seen 🙂 labels Sep 11, 2020
@fw-bot
Copy link
Contributor Author

fw-bot commented Sep 11, 2020

Ping @raf-odoo, @Feyensv
Cherrypicking 59c8331 of source #57270 failed

stderr:

error: could not apply 59c8331bdc9... [FIX] doc: Truncate 680-line example data
hint: after resolving the conflicts, mark the corrected paths
hint: with 'git add <paths>' or 'git rm <paths>'
hint: and commit the result with 'git commit'

Either perform the forward-port manually (and push to this branch, proceeding as usual) or close this PR (maybe?).

In the former case, you may want to edit this PR message as well.

@C3POdoo C3POdoo added the RD research & development, internal work label Sep 11, 2020
@robodoo robodoo added CI 🤖 Robodoo has seen passing statuses ☑ ci/runbot and removed ☐ ci/runbot labels Sep 11, 2020
@raf-odoo raf-odoo force-pushed the saas-11.3-11.0-doc-fixes-raf-q5Fg-fw branch from 3ca688b to 76da47d Compare September 14, 2020 07:45
@robodoo robodoo added ☐ ci/runbot and removed CI 🤖 Robodoo has seen passing statuses ☑ ci/runbot labels Sep 14, 2020
@raf-odoo
Copy link
Contributor

@robodoo r+

raf-odoo and others added 2 commits September 14, 2020 12:23
Added an example because it's non-trivial to realize why you would want
to set `mode` to `primary` together with `inherit_id`.

Another way to look at it is that the view matching doesn't understand
delegation inheritance. If it did there would be no need to override
`mode` because it would be able to see that the parent and derived views
refer to related models. But since that feature might not be worth the
effort, it's ok for me to just document the current situation.
The behavior isn't exactly undefined: it will appear to work if the
relation refers to only 1 instance. If there are multiple it will give
results for 1 instance and ignore the others. This behavior should not
be relied upon, hence I'm documenting it as undefined. I confirmed this
with mat from the ORM team.

Even better would be to raise an error or warning if `related` is used
in this context.

Co-authored-by: Raf Geens <raf@odoo.com>
@raf-odoo raf-odoo force-pushed the saas-11.3-11.0-doc-fixes-raf-q5Fg-fw branch from 76da47d to d01b29a Compare September 14, 2020 10:26
@robodoo robodoo added ☐ ci/runbot and removed CI 🤖 Robodoo has seen passing statuses ☑ ci/runbot labels Sep 14, 2020
@raf-odoo
Copy link
Contributor

@robodoo r+

@robodoo robodoo added r+ 👌 CI 🤖 Robodoo has seen passing statuses and removed ☐ legal/cla labels Sep 14, 2020
@robodoo
Copy link
Contributor

robodoo commented Sep 14, 2020

Because this PR has multiple commits, I need to know how to merge it:

  • merge to merge directly, using the PR as merge commit message
  • rebase-merge to rebase and merge, using the PR as merge commit message
  • rebase-ff to rebase and fast-forward

@Feyensv
Copy link
Contributor

Feyensv commented Sep 14, 2020

@robodoo rebase-ff

robodoo pushed a commit that referenced this pull request Sep 14, 2020
The behavior isn't exactly undefined: it will appear to work if the
relation refers to only 1 instance. If there are multiple it will give
results for 1 instance and ignore the others. This behavior should not
be relied upon, hence I'm documenting it as undefined. I confirmed this
with mat from the ORM team.

Even better would be to raise an error or warning if `related` is used
in this context.

closes #57580

Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
Signed-off-by: Raf Geens <raf-odoo@users.noreply.github.com>
Co-authored-by: Raf Geens <raf@odoo.com>
@robodoo
Copy link
Contributor

robodoo commented Sep 14, 2020

Merge method set to rebase and fast-forward

@robodoo robodoo closed this Sep 14, 2020
@robodoo robodoo temporarily deployed to merge September 14, 2020 12:40 Inactive
@fw-bot fw-bot deleted the saas-11.3-11.0-doc-fixes-raf-q5Fg-fw branch September 28, 2020 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI 🤖 Robodoo has seen passing statuses conflict There was an error while creating this forward-port PR forwardport This PR was created by @fw-bot RD research & development, internal work
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants