Docs: README местами описывает API до 1.1.0#3
Open
dkxmercury wants to merge 1 commit into
Open
Conversation
- секция uEncoderISR описывала класс и конструктор как uEncoder (копипаста), а описание работы tick было от опросного класса - пример предлагал раскомментировать eb.tickISR() на uEncButton, у которого этого метода больше нет, только у uEncButtonISR
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Мелочь, но спотыкаешься сразу: README местами остался от версии до 1.1.0.
Что поправил
1. Секция
#### uEncoderISR- копипаста из секцииuEncoder, класс не переименовали:uEncoderнаследует...», стало «КлассuEncoderISRнаследует...»uEncoder(uint8_t p0, ...), сталоuEncoderISR(...)pollвнутриtick» переехало из опросного класса и для ISR-варианта неверно:pollтам приватный (using uEncoderVirt::pollв private), аtickразгребает буфер. Переписал по факту: опрос вtickISR, результат в буфер на 4 щелчка,tickдостаёт по одному событию.2. Пример предлагал раскомментировать
eb.tickISR()иattachInterruptна объектеuEncButton:После 1.1.0 у
uEncButtonметодаtickISRнет вообще (он только уuEncButtonISR), так что раскомментировать это нельзя - не соберётся. Убрал эти строки, тем более что в реальномexamples/demo/demo.inoих и нет, и добавил строчку под примером, что режим прерываний - этоuEncButtonISRи примерdemoISR.README_EN не трогал
Он отстал целиком: секций
uEncoderISR/uEncButtonISRтам нет вовсе, зато уuEncoderиuEncButtonдо сих пор документированtickISR. Но он явно генерится автоматом (судя по стилю перевода), поэтому лезть туда руками не стал - подтянется от русского. Если нет, скажи, поправлю отдельно.Кстати, давно смотрю тебя на ютубе и читаю канал в тг, так что помочь либам было в радость. Спасибо за то, что всё выкладываешь открыто, вместе с исходниками и разбором сборки - это редкость.
Видел твой ответ в uButton#3 про то, что PR не принимаешь и пишешь сам. Твоё право. Если возьмёшь как есть, буду рад, а нет - просто перенеси правки к себе, тут их на минуту.