Skip to content

Привел в порядок описание API плагина БазовыеУтверждения#842

Merged
artbear merged 3 commits into
vanessa-opensource:developfrom
sulfur17:develop
Feb 27, 2021
Merged

Привел в порядок описание API плагина БазовыеУтверждения#842
artbear merged 3 commits into
vanessa-opensource:developfrom
sulfur17:develop

Conversation

@sulfur17

Copy link
Copy Markdown
Contributor

сделанные изменения:

  • убрал описание метода ПроверитьРавенствоТабличныхДокументовТолькоПоЗначениям, т.к. он перенесен в плагин УтвержденияПроверкаТаблиц;
  • добавил описание метода ПроверитьРавенствоФайлов;
  • убрал из описания методов сложную для понимания практику "параметров плавающего назначения"
    • ПроверитьВыполнилось
    • ПроверитьНеВыполнилось
    • ПроверитьМетодВыполнился
    • ПроверитьМетодНеВыполнился
  • формат описания других методов сделал более однообразным

@vanessa-opensource/Collaborators - просьба прокомментировать и проверить

@artbear artbear added this to the 6.7.0 milestone Feb 26, 2021
@artbear

artbear commented Feb 26, 2021

Copy link
Copy Markdown
Collaborator

@sulfur17 Исправления полезные.

убрал из описания методов сложную для понимания практику "параметров плавающего назначения"

Только вот с этим вопрос.
описание мутное, согласен, зато использовать удобно,
не нужно передавать лишний пустой параметр в некоторых случаях.

@artbear

artbear commented Feb 26, 2021

Copy link
Copy Markdown
Collaborator

@sulfur17 может быть, сделать просто 2 примера

  • когда есть Параметры
  • когда вместо Параметров передается ожидание или результат?

@sulfur17

Copy link
Copy Markdown
Contributor Author

@artbear ваш метод очень интересный, мне даже в голову не приходило что так можно. Но если хотите знать мое мнение - писать лишние пустые параметры гораздо проще чем разобраться какой параметр в таком плавающем подходе за что будет отвечать. Вот допустим какие параметры я тут передаю?
ПроверитьНеВыполнилось("строка", "первое сообщение", "второе сообщение")
ПараметрыИлиОжидаемоеОписаниеОшибки чему равно - "первое сообщение" или Неопределено?
а "второе сообщение" - это ОжидаемоеОписаниеОшибки или ДопСообщениеОшибки?
лично мне, как пользователю плагина, придется лезть в код чтобы ответить на эти вопросы, а хотелось бы чтобы все было интуитивно понятно.

Я конечно исправлю как скажете, но прошу вас обдумать мои аргументы.

@artbear

artbear commented Feb 26, 2021

Copy link
Copy Markdown
Collaborator

@ Я согласен, что подобное поведение может и путать.

такое поведение уже много лет )

сейчас исправить уже сложно, т.к. куча клиентов использует именно такой интерфейс и не хотелось бы им ломать их тесты.

предлагаю оставить как есть, только добавить простые примеры вызова в 2х вариантах, как я предложил выше.

если не хочешь, тогда я готов замержить и в текущем варианте )

@sulfur17

Copy link
Copy Markdown
Contributor Author

у них ничего не сломается, потому что я в коде ничего не менял.

Я просто дал другие имена параметрам в документации.
Они стали короткими и однозначными, без "или".
Теперь люди будут передавать пустые параметры, не зная что можно этого не делать.
Но и с пустыми и без пустых параметров все должно работать одинаково.
Так что я предлагаю смержить как есть, мне уже не хочется исправлять)

@artbear
artbear merged commit 092cfc7 into vanessa-opensource:develop Feb 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants