Skip to content

Conversation

@harshitpawar64
Copy link
Contributor

✨ Description

This PR addresses documentation quality issues:

  • Fixed multiple typos throughout the codebase
  • Corrected broken documentation links in both CONTRIBUTING.md and the PR template

These fixes help keep our docs and code comments clean and accurate without affecting functionality.

🔍 Type of change

Select all that apply:

  • 🐛 Bug fix (non-breaking change that addresses a specific issue)
  • 🚀 New feature (non-breaking change that adds functionality)
  • ⚠️ Breaking change (a change that could affect existing functionality)
  • 📈 Performance improvement/optimization (improves speed, memory usage, or efficiency)
  • 🛠️ Code refactor (non-functional changes that improve code readability, structure, etc.)
  • 📦 Dependency bump (updates dependencies, including Dockerfile or package changes)
  • 📝 Documentation change (link fixes and typo corrections)
  • 🔧 Infrastructure/Build change (affects build process, CI/CD, or dependencies)

📝 Changes

List the key changes introduced in this PR:

  1. Fixed typos in:

    • setup.cfg
    • config.py
    • utils.py
    • mamba_layer.py
    • discrete_mamba2.py
    • preprocessing.py
    • huggingface.py
  2. Updated broken links in:

    • CONTRIBUTING.md
    • .github/PULL_REQUEST_TEMPLATE.md

✅ Checklist

Make sure the following tasks are completed before submitting the PR:

General

  • 📜 I have read and followed the contributing guidelines.
  • 🏷️ I am using a clear and descriptive PR title that summarizes the key change or feature introduced.
  • 🎉 The functionality is complete, and I have tested the changes.
  • 📝 I have updated the documentation if needed.
  • ⚠️ The change does not introduce any new issues (e.g., runtime warnings, type checker errors, linting problems, unhandled edge cases).
  • 🧩 I have commented my code, especially in hard-to-understand areas.

Testing

  • ✔️ New and existing tests pass locally with my changes. (no functionality changed)

Performance Impact

  • ✅ No performance impact (documentation-only changes)

- Fixed multiple typos
- Updated broken links in CONTRIBUTING.md and PR template
Copy link
Collaborator

@jlamypoirier jlamypoirier left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@jlamypoirier jlamypoirier merged commit 5ec92ca into ServiceNow:main Jun 4, 2025
@harshitpawar64 harshitpawar64 deleted the fix/typos-and-broken-link branch June 5, 2025 04:27
@harshitpawar64 harshitpawar64 restored the fix/typos-and-broken-link branch June 6, 2025 04:37
@harshitpawar64 harshitpawar64 deleted the fix/typos-and-broken-link branch June 6, 2025 04:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants