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

Improve messages and task descriptions for better consistency and clarity #5750

Closed
wants to merge 2 commits into from

Conversation

Tmthang1601
Copy link

This PR improves the consistency and clarity of messages and task descriptions across Hardhat documentation and codebase. The changes include:

  1. In packages/hardhat-core/src/internal/cli/cli.ts:

    • Refactored the deprecation warning message to be more concise and clear.
  2. In docs/src/content/hardhat-runner/docs/getting-started/index.md:

    • Updated the task list with more concise and consistent descriptions.
    • Improved the description of the 'check' task to be more specific.
  3. In packages/hardhat-core/src/builtin-tasks/check.ts:

    • Clarified the description of the 'check' task to better reflect its purpose.
  4. In docs/src/content/hardhat-runner/docs/guides/tasks.md:

    • Added an example of running a task with a network parameter to provide more comprehensive guidance.

These changes aim to enhance the user experience by providing more consistent and informative messages throughout the Hardhat ecosystem. The improvements should make it easier for both new and experienced users to understand and use Hardhat's features effectively.

- Refactored deprecation warning in cli.ts for clarity
- Updated task descriptions in getting-started/index.md for consistency
- Clarified 'check' task description in check.ts
- Added network parameter example in tasks.md guide

Detailed changes:
1. cli.ts: Shortened and clarified deprecation warning message
2. getting-started/index.md: Updated task list with more concise and consistent descriptions
3. check.ts: Improved 'check' task description to be more specific
4. tasks.md: Added example of running a task with network parameter

These changes aim to improve the overall consistency and clarity of Hardhat's documentation and messages, making them more user-friendly and informative.
Copy link

changeset-bot bot commented Sep 15, 2024

⚠️ No Changeset found

Latest commit: f5162cd

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Sep 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hardhat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 16, 2024 5:59am

@Tmthang1601
Copy link
Author

Hi @kanej, I hope you're doing well! I just wanted to follow up on this pull request to see if there are any updates or if any changes are needed on my end. I'm happy to make any adjustments if necessary. Thanks a lot for your time and consideration!

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

Successfully merging this pull request may close these issues.

2 participants