JedWatson / react-select

The Select Component for React.js
https://react-select.com/
MIT License
27.63k stars 4.13k forks source link

Bug Report: Mismatch between Function Titles and Descriptions in Documentation #5962

Open MisterCommit opened 1 month ago

MisterCommit commented 1 month ago

image

https://react-select.com/props#select-props

Bug Report: Mismatch between Function Titles and Descriptions in Documentation

Description
There appears to be a mismatch between the function titles and their descriptions in the documentation. Specifically, the titles and descriptions for event handler functions are inconsistent, which may lead to confusion for developers integrating react-select into their projects.

Steps to Reproduce

  1. Refer to the documentation of event handler functions like onKeyDown, onMenuOpen, and onMenuClose.
  2. The descriptions don't align with what the functions actually do. For example, the onKeyDown function description mentions handling change events, whereas it should refer to handling key down events.

Expected Behavior
The function descriptions should correctly reflect their behavior. For example:

Actual Behavior

Test Case
This issue is present in the documentation. A specific code example may not be necessary, but reviewing the relevant documentation for accuracy should suffice.

Versions

Additional Notes
Providing accurate documentation helps developers better understand how to integrate and use these event handler functions in their projects. This small fix could prevent confusion and enhance the developer experience with react-select.

Methuselah96 commented 1 month ago

The description for each prop comes under the prop name, not above it, does that clear it up?