8000 docs: fix simple typo, successfull -> successful by timgates42 · Pull Request #321 · aubio/aubio · GitHub
[go: up one dir, main page]

Skip to content

docs: fix simple typo, successfull -> successful - #321

Closed
timgates42 wants to merge 1 commit into
aubio:masterfrom
timgates42:bugfix_typo_successful
Closed

timgates42 wants to merge 1 commit into
aubio:masterfrom
timgates42:bugfix_typo_successful

Conversation

@timgates42
Copy link
Copy Markdown
Contributor

There is a small typo in src/effects/pitchshift.h, src/effects/timestretch.h, src/pitch/pitch.h.

Should read successful rather than successfull.

There is a small typo in src/effects/pitchshift.h, src/effects/timestretch.h, src/pitch/pitch.h.

Should read `successful` rather than `successfull`.
@autoantwort autoantwort mentioned this pull request Dec 7, 2020
joshsc63 pushed a commit to joshsc63/aubio-modernized that referenced this pull request Oct 28, 2025
Merges essential compatibility fixes from upstream aubio community:

- PR aubio#418: FFmpeg deprecated channel layout fix (Lluc Simó)
- PR aubio#416: Python regex raw strings (Pink Serenity)
- PR aubio#407: Big-endian FLAC support (Thomas Perale)
- PR aubio#371: MSVC UTF-8 encoding (lidotcircle)
- PR aubio#321: Documentation typo fix (Tim Gates)
- PR aubio#411: Demo script output fix (Stefan Sauer)

These fixes enhance aubio-modernized compatibility with:
✅ FFmpeg 7.0/8.0+ (channel layout API)
✅ Python 3.x best practices (raw strings)
✅ Big-endian architectures (MIPS, PowerPC)
✅ Windows MSVC (UTF-8 support)
✅ Documentation quality
✅ Demo usability

All changes are minimal, targeted fixes from community contributors.
Credits to original PR authors for their excellent work.

Related: aubio#418, aubio#416, aubio#407, aubio#371, aubio#321, aubio#411
@joshsc63
Copy link
Copy Markdown

Thank you @timgates42 for this documentation quality improvement! 🎉

Your fix has been included in PR #428, which consolidates 8 community PRs for easier maintainer review:
#428

What's Included

PR #428 includes your documentation typo fix alongside:

  • NumPy 1.26.4 + GCC 14 compatibility
  • FFmpeg 7.0/8.0 compatibility
  • Python regex improvements
  • Big-endian FLAC support
  • Windows MSVC UTF-8 encoding
  • Demo improvements

Why Consolidate?

Since this PR has been open since 2020 (with community approval) and several others have been awaiting review, I've consolidated them to:

  • ✅ Speed up integration of valuable community fixes
  • ✅ Reduce review overhead for maintainers
  • ✅ Preserve all original authorship (git history intact)
  • ✅ Benefit the entire aubio ecosystem

Your Credit

Your authorship is fully preserved in:

Thank you for improving aubio's documentation quality!

@joshsc63
Copy link
Copy Markdown

🚀 Available Now in aubio-modernized

Your documentation fix is already live in aubio-modernized!

Installation

pip install git+https://github.com/joshsc63/aubio-modernized.git@master

Repository

https://github.com/joshsc63/aubio-modernized

Users can benefit from improved documentation quality immediately. Thank you for your contribution!

@piem piem closed this in 71c0d2f Nov 15, 2025
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.

3 participants

0