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

doc: clarify after and afterEach hooks execution #51523

Merged
merged 5 commits into from
Feb 3, 2024

Commits on Jan 19, 2024

  1. doc: clarify execution of after hook on test suite completion

    The `after` hook now explicitly mentions that it is executed once after
    all the tests in a test suite have completed, regardless of whether the
    tests passed or failed. This ensures that cleanup tasks or actions
    specified in the after hook are guaranteed to run.
    
    Refs: nodejs#50901
    ognjenjevremovic committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    1a23c68 View commit details
    Browse the repository at this point in the history
  2. doc: clarify execution of afterEach hook after each test

    The `afterEach` hook is now documented to be executed after each
    individual test in a test suite, irrespective of whether the test passed
    or failed. Developers can rely on this hook for performing cleanup or
    resetting state after each test.
    
    Refs: nodejs#50901
    ognjenjevremovic committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    19da229 View commit details
    Browse the repository at this point in the history
  3. doc: improve clarity in after and afterEach hook documentation

    Refined the language in the documentation for the `after` and
    `afterEach`
    hooks to enhance clarity. Replaced instances of "note that" with more
    direct and concise language for better readability.
    
    Refs: nodejs#50901
    ognjenjevremovic committed Jan 19, 2024
    Configuration menu
    Copy the full SHA
    669ccaa View commit details
    Browse the repository at this point in the history

Commits on Jan 20, 2024

  1. doc: improve clarity in after and afterEach hook documentation

    Refined the documentation for the `after` and `afterEach` hooks to
    enhance clarity. Removed redundant information and retained the
    essential details. The revised note now explicitly states that the
    `after` and `afterEach` hooks are guaranteed to run, even if tests
    within the suite fail.
    
    Refs: nodejs#50901
    ognjenjevremovic committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    8a1bedd View commit details
    Browse the repository at this point in the history
  2. doc: address line length linting error in documentation

    Adjusted line lengths in the documentation to adhere to the maximum
    allowed limit of 80 characters. This change resolves the linting error.
    
    Refs: nodejs#50901
    ognjenjevremovic committed Jan 20, 2024
    Configuration menu
    Copy the full SHA
    4311384 View commit details
    Browse the repository at this point in the history