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

Minor readme updates #340

Merged
merged 6 commits into from
Feb 22, 2018
Merged

Conversation

Blasz
Copy link
Member

@Blasz Blasz commented Feb 22, 2018

Hey Alex,

I was going through the README tonight and noticed a few typos so thought I'd raise a PR to fix them.

I ended up re-ordering/restructuring some headers as well under draggable since I was finding it a bit hard to read and thought the headers would be better suited to be more accurate if displayed in a table of content.

I had a couple of questions after going through the doc that I'm not sure whether needs addressing or not.

  1. Would it be worth adding a table of contents? The README is quite large, which is good, but I think a table of contents would allow easier navigation.
  2. With regards to the droppable scroll container restrictions, is the window (html/body) excluded from being defined as a scroll parent? I noticed this distinction is made in the auto scroll section but not in the generic scroll container section
  3. There is mention to both visible and visual draggable sibings. Are they interchangeable terms or should we stick with one?
  4. I found the term Draggable Props to be a bit overloaded as it was being used for both the props that can be passed to the Draggable component itself and also the props coming out of the provided child function argument that are then passed to the Draggable node/inner ref element.
  5. I found the usage of DraggableProps > style a bit obscure when referring to the style prop of DraggableProps, what do you think about using DraggableProps.style instead?

Am happy to update the PR in response to any of the questions above.

Cheers.

@Blasz Blasz requested a review from alexreardon February 22, 2018 12:21
@alexreardon
Copy link
Collaborator

Yes to everything!

@alexreardon
Copy link
Collaborator

How soon could you action these? I am hoping to do a release this morning

@Blasz
Copy link
Member Author

Blasz commented Feb 22, 2018

I can try as soon as I get in, 30 - 60 mins

@alexreardon
Copy link
Collaborator

alexreardon commented Feb 22, 2018 via email

@alexreardon alexreardon merged commit 03036b8 into atlassian:master Feb 22, 2018
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.

3 participants