Skip to content

Conversation

@Iucapad
Copy link
Contributor

@Iucapad Iucapad commented Nov 15, 2021

This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

@Iucapad Iucapad requested a review from ged-odoo November 15, 2021 15:08
@robodoo
Copy link
Collaborator

robodoo commented Nov 15, 2021

@Iucapad
Copy link
Contributor Author

Iucapad commented Nov 15, 2021

This doc is related to a component currently available from the master branch of odoo/enterprise. It may not be the right time to add this documentation as it it not available in 15.0. But maybe we can at least start reviewing it @ged-odoo

@C3POdoo C3POdoo requested a review from a team December 9, 2021 11:16
@Iucapad Iucapad force-pushed the master-actionswiper-doc-luvi branch from aca23be to 503c807 Compare December 14, 2021 07:41
@Iucapad Iucapad changed the base branch from master to saas-15.1 December 14, 2021 07:42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe use some more realistic function name: doSomething and doSomethingElse instead of Object

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, i did not know the API for this component. Note that it is not intuitive, in my opinion. It should be something like onLeftSwipe (function), onRightSwipe (function), leftColor, rightColor, ... (with defaults if possible)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I keep the current documentation until the API is changed in the future?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure the screenshot really helps. I would change it to a screenshot of a single action swiper, nothing else, and put it in the description section. Then, remove this and the sentence l283

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I edited the screenshot to only show one simple component. You're right, it's better like that. I like images in documentations, it helps me as a developer to see what it can do (so please keep this image and encourage the practice :) )

@Iucapad Iucapad force-pushed the master-actionswiper-doc-luvi branch from 503c807 to 73f8bda Compare December 14, 2021 08:39
@Iucapad Iucapad force-pushed the master-actionswiper-doc-luvi branch from 73f8bda to 298179b Compare December 15, 2021 08:02
@ged-odoo ged-odoo requested a review from a team December 15, 2021 08:05
Copy link
Collaborator

@AntoineVDV AntoineVDV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@robodoo delegate=ged-odoo

This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.
@Iucapad Iucapad force-pushed the master-actionswiper-doc-luvi branch from 298179b to 77635aa Compare December 15, 2021 09:10
@ged-odoo
Copy link
Contributor

robodoo r+

robodoo pushed a commit that referenced this pull request Dec 16, 2021
This commit adds the developer documentation for a
component recently added to the web_enterprise module.
It also includes examples and a screenshot used in the
documentation.

closes #1315

Signed-off-by: Géry Debongnie <ged@odoo.com>
@robodoo robodoo closed this Dec 16, 2021
@robodoo robodoo temporarily deployed to merge December 16, 2021 18:38 Inactive
@fw-bot
Copy link
Collaborator

fw-bot commented Dec 20, 2021

This pull request has forward-port PRs awaiting action (not merged or closed): #1432

1 similar comment
@fw-bot
Copy link
Collaborator

fw-bot commented Dec 21, 2021

This pull request has forward-port PRs awaiting action (not merged or closed): #1432

@fw-bot fw-bot deleted the master-actionswiper-doc-luvi branch December 30, 2021 18:47
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

Successfully merging this pull request may close these issues.

5 participants