GithubHelp home page GithubHelp logo

react-hooks-component-props-mini-project's Issues

Typo of props for ArticleList

Canvas Link

https://learning.flatironschool.com/courses/6383/assignments/235196?module_item_id=551844

Concern

In the instructions for ArticleList, it is stated that the props passed down to ArticleList will be post (singular): an array of Article components (one component for each post passed down as a prop called post to ArticleList).

However, the tests for this lab make clear that ArticleTest will be tested with a prop called posts (plural):

test("renders a <main> element", () => {
  const { container } = render(<ArticleList posts={posts} />);
  expect(container.querySelector("main")).toBeInTheDocument();
});

Given that the prop is an array, the plural form makes more sense, and I think it would be clearer if it were referred to as such in the instructions.

Additional Context

I paired with a Technical Coach who agreed that this seemed like a typo in the instructions, and suggested I flag the issue here.

Suggested Changes

Just a typo change--changing "post" to "posts" in the instructions would suffice, I think!

Update README to be more clear on prop naming expectations

Canvas Link

https://learning.flatironschool.com/courses/5842/assignments/214265

Concern

In the deliverables, the expected name of the prop is italicized but I think it should be made more clear that they need to name the props correctly or they will not pass the tests. For example, change the first deliverable from
an <h1> with the _name_ of the blog, passed as a prop to
an <h1> with the name of the blog, passed as a prop called name

It is currently not clear enough and the error messages that are returned from learn test when their code works but they're just naming their props incorrectly is not helpful to the student. I.E.: I changed the prop name "posts" to "articles" (Which I have seen multiple students do) but this is the error they get from learn test:
Screen Shot 2023-01-30 at 4 54 39 PM
This is confusing for students because their articles are rendering just fine but the test is not passing. It is difficult for students to look at this error and understand that they just need to rename articles to posts to get their tests passing.

Additional Context

Since codegrade will require all tests to pass before they can submit the assignment, I highly recommend making this change before phase two when codegrade is live with students.

Suggested Changes

No response

Please Consider Renaming 'Article' And 'ArticleList' To 'Post' And 'PostList'

Canvas Link

https://learning.flatironschool.com/courses/5285/assignments/172447?module_item_id=376309

Concern

The following should be revised for this lesson:
'Article' and 'ArticleList' components should be renamed to 'Post' and 'PostList'.

This is because this is a blog website with posts, and not academic articles. The context with the naming is weird, and would be easier if this was just renamed accordingly.

Additional Context

No response

Suggested Changes

Mentioned above ^

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.