Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝[Docs]: #271

Open
vaishnavipal1869 opened this issue Oct 21, 2024 · 3 comments
Open

📝[Docs]: #271

vaishnavipal1869 opened this issue Oct 21, 2024 · 3 comments

Comments

@vaishnavipal1869
Copy link
Contributor

What Docs changes are you proposing?
I suggest adding a troubleshooting section to the documentation and making some minor grammatical corrections for clarity.

Why do the Docs need this improvement? What is the motivation for this change? How will this change benefit the community?
The current documentation can be confusing for users, especially when they run into common issues. A troubleshooting section will help them quickly find solutions, improving their overall experience. Clearer language will also make it easier for everyone to understand the instructions.

Describe the solution you'd like

  1. Add a Troubleshooting Section:
  • Dependency Installation Issues: Tips for resolving common installation errors with BeautifulSoup or Pandas.
  • Scraping Errors: Steps to take if the script fails to fetch reviews or if there are changes to the website.
  • CSV Format Issues: Guidance on ensuring the uploaded CSV file is correctly formatted.
  1. Grammar and Clarity Improvements:
  • Change "Scrapping the movie review" to "Scraping Movie Reviews."
  • Make the introduction more concise: change "providing valuable data for analysis and research purposes" to "to facilitate analysis and research."

Describe alternatives you've considered
I thought about creating a separate FAQ section, but I believe having a dedicated troubleshooting section will be more helpful for users.

Additional context
These changes will enhance user experience and make the documentation more effective for everyone involved.

@vaishnavipal1869 vaishnavipal1869 added the enhancement New feature or request label Oct 21, 2024
Copy link

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions or additional information, feel free to add them here. Your contributions are highly appreciated! 😊

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.

Copy link

Thank you for raising a issue, Hope you enjoing the open source. we try to reply or assign as soon possibe. Connect with mentor.

@vaishnavipal1869
Copy link
Contributor Author

hi could you please assign me with this issue so i can start working on it soon, thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants