chore(docs): Improve docstrings

[Anavelyz]

Description

• Fix DataFrame word in the docstrings
• Improving the docstrings

Related Issue

#197

Checklist

• I've read the CODE_OF_CONDUCT.md document.
• I've read the CONTRIBUTING.md guide.
• I've used pre-commit hook locally.
• I've written tests for all new methods and classes that I created.
• I've written the docstring in Google format for all the methods and classes that I used.
• Semantic-release prefix title used (case sensitive):
  • Use the prefix chore(docs): for Examples / docs / tutorials / dependencies update
  • Use the prefix fix: for a bug fix
    (non-breaking change which fixes an issue).
  • Use the prefix chore(improvement): for an improvement
    (non-breaking change which improves an existing feature).
  • Use the prefix feat: for a new feature
    (non-breaking change which adds functionality).
  • Use the prefix BREAKING CHANGE: for a breaking change
    (fix or feature that would cause existing functionality to change).
  • Use the prefix chore(security): for a security fix.

[xmnlab]

I haven't read it in details, but in general it looks good to me.
@eduardocorrearaujo could you review this one by chance? thanks

[github-actions]

Stale pull request message

[xmnlab]

I think we probably should try to move this forward.

[Anavelyz]

@xmnlab What should I do to help with this?

[xmnlab]

@Anavelyz could you please fix the issues that are occurring on CI, please?

[xmnlab]

@Anavelyz have you closed this on purpose?

[Anavelyz]

@Anavelyz have you closed this on purpose?

No, I was trying to do a fetch and deleted the commits, then git didn't see any changes so it closed

[xmnlab]

Thanks @Anavelyz for working on that. In general looks good. Just noted that some docstrings are not in the numpydocs standard. Could you move that docstrings to numpydics too please? Thanks!!

[Anavelyz]

Thanks @Anavelyz for working on that. In general looks good. Just noted that some docstrings are not in the numpydocs standard. Could you move that docstrings to numpydics too please? Thanks!!

Ready!

[xmnlab]

just one small comment inline.
please fix that and ping me again and we can merge this pr.
thanks!

[xmnlab]

LGTM! thanks for working on that

[github-actions]

🎉 This PR is included in version 2.1.0 🎉

The release is available on:

• 2.1.0
• GitHub release

Your semantic-release bot 📦🚀