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

Components: Include stylesheet in usage instructions. #15241

Merged
merged 1 commit into from
Apr 29, 2019

Conversation

iandunn
Copy link
Member

@iandunn iandunn commented Apr 29, 2019

Without these it's easy to think something is broken, or that you're doing something wrong, until you realize that it's just that the missing CSS. Documenting this will save time and frustrating.

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

It seems like a great idea to add this note. I'm wondering whether we should add a similar note to all packages which also ship styles like block-library or format-library.

@gziolo
Copy link
Member

gziolo commented Apr 29, 2019

There is an unrelated issue with e2e test:

https://travis-ci.com/WordPress/gutenberg/jobs/196208309#L1161

FAIL specs/block-hierarchy-navigation.test.js (7.863s)
  ● Navigating the block hierarchy › should navigate block hierarchy using only the keyboard
    expect(received).toMatchSnapshot()
    Snapshot name: `Navigating the block hierarchy should navigate block hierarchy using only the keyboard 1`
    - Snapshot
    + Received
    @@ -9,9 +9,13 @@
      <div class="wp-block-column"></div>
      <!-- /wp:column -->
      
      <!-- wp:column -->
      <div class="wp-block-column"><!-- wp:paragraph -->
    - <p>Third column</p>
    + <p></p>
      <!-- /wp:paragraph --></div>
      <!-- /wp:column --></div>
    - <!-- /wp:columns -->"
    + <!-- /wp:columns -->
    + 
    + <!-- wp:image -->
    + <figure class="wp-block-image"><img alt=""/></figure>
    + <!-- /wp:image -->"
      80 | 		await page.keyboard.type( 'Third column' );
      81 | 
    > 82 | 		expect( await getEditedPostContent() ).toMatchSnapshot();
         | 		                                       ^
      83 | 	} );
      84 | 
      85 | 	it( 'should appear and function even without nested blocks', async () => {
      at Object.toMatchSnapshot (specs/block-hierarchy-navigation.test.js:82:42)
      at tryCatch (../../node_modules/regenerator-runtime/runtime.js:62:40)
      at Generator.invoke [as _invoke] (../../node_modules/regenerator-runtime/runtime.js:288:22)
      at Generator.prototype.(anonymous function) [as next] (../../node_modules/regenerator-runtime/runtime.js:114:21)
      at asyncGeneratorStep (specs/block-hierarchy-navigation.test.js:9:103)
      at _next (specs/block-hierarchy-navigation.test.js:11:194)

It's an interminient failure and I'm documenting it only so I could reference it in a follow-up PR where I will disable it.

@iandunn
Copy link
Member Author

iandunn commented Apr 29, 2019

I think that's a good idea, I opened #15253 to track that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Components /packages/components [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants