updated DataFrame.equals docstring
- [x] closes #29408
- [x] tests added / passed
- [x] passes `black pandas`
- [x] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`

Note: I tested the documentation locally and the links to assert_*_equals are working now.