Material-ui: [Docs] styled section, source does not match the docs signature

Created on 29 Jan 2019  路  10Comments  路  Source: mui-org/material-ui

  • [x] This is not a v0.x issue.
  • [x] I have searched the issues of this repository and believe that this is not a duplicate.

Expected Behavior 馃

The title in the /css-in-js/api/ styled section should match the implementation, just like the example does.

Current Behavior 馃槸

The order of arguments are wrong in the title.

Steps to Reproduce 馃暪

Link:

  1. https://material-ui.com/css-in-js/api/

Context 馃敠

Not needed.

Your Environment 馃寧

browser

| Tech | Version |
|--------------|---------|
| Material-UI | v3.9.1 |
| React | |
| Browser | |
| TypeScript | |
| etc. | |

docs good first issue styles

Most helpful comment

@joshwooding Hello! Can I submit a PR for this issue?

All 10 comments

@htondkar Which functions specifically? Could you add an example that includes the current title and what title it should display?

If I鈥檓 reading this correctly the suggestion is that the title matches the currying implementation so something more similar to styled(Component)(styles, [options]) => Component

@joshwooding Yes, the header is incorrect 馃憤.

-## `styled(styles, [options])(Component) => Component`
+## `styled(Component)(styles, [options]) => Component`

@htondkar Great spot! 馃憖 Do you want to submit a pull request with the suggested change?

@joshwooding Hello! Can I submit a PR for this issue?

@gutofoletto Sure 馃憤 if you haven鈥檛 read it before you can find the contributing guide here

I just opened #14418
Even after reading the docs I had a doubt about which branch to target. some [docs] PRs are open pointing to master and others are pointing to next.
I targeted master, but if thats wrong just let me know that I will change to next

@gutofoletto I have moved the pull request to the next branch. We keep the master branch for important bug fixes. We try to focus our energy on a single moving target. Well done :).

Perfect! Thank you! :D

Thank you guys :+1: :smile:

Was this page helpful?
0 / 5 - 0 ratings

Related issues

ghost picture ghost  路  3Comments

finaiized picture finaiized  路  3Comments

rbozan picture rbozan  路  3Comments

sys13 picture sys13  路  3Comments

pola88 picture pola88  路  3Comments