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.

Sign up for GitHub

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

Jump to bottom

Document all Block API functions #468

Closed
nylen opened this issue Apr 20, 2017 · 2 comments
Closed

Document all Block API functions #468

nylen opened this issue Apr 20, 2017 · 2 comments
Labels
[Feature] Block API API that allows to express the block paradigm. [Type] Developer Documentation Documentation for developers [Type] Task Issues or PRs that have been broken down into an individual action to take
Milestone
Beta 0.4.0

Comments

@nylen
Copy link
Member

nylen commented Apr 20, 2017

blocks/README.md needs some updating, or a new document needs to be created, especially after #438. For example, it's common for blocks to need to pull out the focus and setFocus properties of the object passed to edit, but it's not very clear what these are or where they come from.

focus in particular is an object whose structure should be documented for block implementers - see #438 (comment)
@nylen nylen added [Type] Developer Documentation Documentation for developers Framework Issues related to broader framework topics, especially as it relates to javascript labels Apr 20, 2017
@youknowriad
Copy link
Contributor

We need to document transforms, insertBlockAfter as well.

@mtias mtias added [Feature] Block API API that allows to express the block paradigm. and removed Framework Issues related to broader framework topics, especially as it relates to javascript labels May 3, 2017
@jasmussen jasmussen added this to the Beta milestone May 16, 2017
@jasmussen jasmussen mentioned this issue May 16, 2017
Closed
@aduth aduth mentioned this issue Jun 14, 2017
Merged
@mtias mtias modified the milestones: Beta 2, Beta Jun 15, 2017
@mtias mtias changed the title Improve documentation of block API functions Document all Block API functions Jun 26, 2017
@mtias mtias added the [Type] Task Issues or PRs that have been broken down into an individual action to take label Jun 26, 2017
@mtias mtias added this to the Beta 3 milestone Jun 26, 2017
@mtias
Copy link
Member

mtias commented Jul 8, 2017

Done in #1794, ongoing work in #1786.

@mtias mtias closed this as completed Jul 8, 2017
@Verdinjoshua26 Verdinjoshua26 mentioned this issue Nov 5, 2022
Open
@Verdinjoshua26 Verdinjoshua26 mentioned this issue Dec 25, 2022
Open
@Verdinjoshua26 Verdinjoshua26 mentioned this issue Oct 1, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
[Feature] Block API API that allows to express the block paradigm. [Type] Developer Documentation Documentation for developers [Type] Task Issues or PRs that have been broken down into an individual action to take
Projects
None yet
Milestone
Beta 0.4.0
Development

No branches or pull requests
4 participants
@nylen @youknowriad @mtias @jasmussen