Skip to content

Conversation

@castastrophe
Copy link
Contributor

@castastrophe castastrophe commented Jun 3, 2020

Documentation updates

What has changed and why

Summarize files edited as part of this MR along with a brief description of what was changed/why.

  • Updated the developer walk-through to reflect current coding and best practices

Ready-for-merge Checklist

Check off items as they are completed. Feel free to delete items if they are not applicable to your PR.

  • Expected files: all files in this pull request are related to one request or issue (no stragglers or scope-creep).
  • Documentation updates are clear and concise.

Merging

Please squash when merging and ensure your commit message uses conventional commit formatting.

Be sure to share your updates with the [email protected] mailing list!

@castastrophe castastrophe changed the title docs: Pull out documentation updates into a separate branch docs: Updates to developer walk-through documentation Jun 3, 2020
@castastrophe castastrophe added the docs Documentation updates label Jun 4, 2020
@castastrophe castastrophe added the ready: code review Ready for code review! label Jun 11, 2020
@castastrophe castastrophe added this to the PFE 1.0 milestone Jun 11, 2020

## Attributes

This component example supports two attributes: `pfe-following` and `pfe-photo-url`. Both attributes are prefixed with `pfe-` to protect their namespacing and prevent collisions with protected attributes in HTML. To indicate this prefixing, set `"prefixed": true` on the object for that attribute. Some attribute names will not be prefixed; in those cases, set the prefixed key to false. Attributes are listed as properties and can use a variety of types. Most will probably be of type `string` or `boolean` but `number` is also supported.
Copy link
Member

Choose a reason for hiding this comment

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

do we want to keep this part about namespacing the attributes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes but we'll have to update it with the latest pfe-c pfe-g namespacing

Copy link
Member

@starryeyez024 starryeyez024 left a comment

Choose a reason for hiding this comment

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

This looks good to me. I'm exempting myself from the accuracy of the JavaScript docs, but it seems to makes sense :)

Copy link
Contributor

@kylebuch8 kylebuch8 left a comment

Choose a reason for hiding this comment

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

Lament Gracefully Thine Misgivings

@kylebuch8 kylebuch8 merged commit 65a1029 into master Jul 29, 2020
@kylebuch8 kylebuch8 deleted the docs-developer-walkthrough branch July 29, 2020 20:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation updates ready: code review Ready for code review!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants