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

clarify the difference between attributes and properties #3856

Open
wants to merge 36 commits into
base: main
Choose a base branch
from

Conversation

smahati
Copy link
Contributor

@smahati smahati commented Aug 15, 2024

Description

Changes proposed in this pull request:

  • documentation suggested for the clarification between attributes and properties

Related issue(s)

Fixed #3848

@smahati
Copy link
Contributor Author

smahati commented Aug 15, 2024

not sure if this is supposed to be in the source code somewhere.

@JohannesDoberer JohannesDoberer self-assigned this Aug 16, 2024
Copy link
Contributor

@JohannesDoberer JohannesDoberer left a comment

Choose a reason for hiding this comment

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

LGTM

@smahati
Copy link
Contributor Author

smahati commented Sep 30, 2024

Added snippets for the compound container, if this looks ok I can add snippets to the other API reference as well.

docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
```js
myContainer.deferInit = true
```
TODO: is it preferred to assign true or declare it to indicate it's set
Copy link
Contributor

Choose a reason for hiding this comment

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

totally fine to set it to true

docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
```

```HTML
<luigi-container viewUrl="/index.html" compoundConfig='{foo: bar}'></luigi-container>
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 if we should provide an example for compould attribute in html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

given the size of it, it seems reasonable to not wanting people to do it this way so I removed it

smahati and others added 13 commits October 7, 2024 09:21
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
smahati and others added 2 commits October 7, 2024 09:25
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
docs/luigi-compound-container-api.md Outdated Show resolved Hide resolved
smahati and others added 16 commits October 11, 2024 16:46
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
Co-authored-by: Johannes Doberer <johannes.doberer@sap.com>
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.

Clarify the difference between attribute and property in Container Docu
2 participants