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

Исправление названия примеров в магических методах #974

Merged
merged 4 commits into from
May 29, 2024

Conversation

RuZniki
Copy link
Contributor

@RuZniki RuZniki commented May 27, 2024

В первом примере заголовок отличается от содержания примера.

Использовал перевод похожий на французский "Utilisation de sleep() et wakeup()".

Использовал перевод похожий на французский "Utilisation de sleep() et wakeup()"
@RuZniki RuZniki requested a review from a team as a code owner May 27, 2024 17:36
Copy link
Member

@mmalferov mmalferov left a comment

Choose a reason for hiding this comment

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

Как заявляет документация, задача функции __sleep() — зафиксировать («усыпить») данные (а если потребуется, — и с предварительной очисткой), которые впоследствии потребуется восстановить («пробудить»).

Дословный перевод заголовка Sleep and wakeup первого примера: Сон и пробуждение. Соглашение предписывает добавлять слово «пример» в заголовки примеров кода. Формально можем задать заголовок: Пример засыпания и пробуждения.

Но если предположить, что слова sleep и wakeup в контексте PHP-документации — сленговые слова (а, видимо, текущая версия ру-перевода и появилась на основе такого предположения; поэтому автор попытался конкретизировать смысл заголовком «Сериализация и десериализация»), то мы должны выбрать:

  1. Оставить текущий заголовок, но добавить к нему слово «пример», чтобы получить:

Пример сериализации и десериализации

(на мой взгляд, текущий перевод некорректен: магические методы __sleep() и __wakeup() не сериализуют и не десериализуют данные, а только подготавливают данные для сериализации и выполняют операции перед десериализацией данных)

  1. Перевести сленг буквально:

Пример засыпания и пробуждения

(не вижу в таком переводе ничего страшного)
3. «Добить» попытку перевести сленг на формальный технический русский язык и составить заголовок, например, так:

Пример подготовки данных к сериализации и выполнения операций перед десериализацией данных

(этот пример мне нравится больше остальных; вариант «Пример засыпания и пробуждения» у меня на втором месте)

  1. Последовать примеру фр-перевода и записать заголовок как:

Пример использования магических методов __sleep() и __wakeup()

P. S. Ну и к заголовкам [4-7] требуется добавить слова «пример», «использование» и «магический метод», чтобы Using __invoke() превратилось в «Пример использования магического метода __invoke()» и т. д. :)

@RuZniki
Copy link
Contributor Author

RuZniki commented May 28, 2024

@mmalferov спасибо большое за обратную связь. Я склоняюсь к 4 предложеному варианту с небольшими изменениями.

Мне кажется избыточным добавления слова "пример" в начале, потому что во время рендинга, перед заголовком добавляется префикс "Пример №1" https://www.php.net/manual/ru/language.oop5.magic.php#example-796
image

Изначально я обратил внимание только на заголовок первого примера, но сейчас я понял что по хорошему надо заголовки все проверить. Заголовоки 4 и 5 разные.

  • Пример #4 Использование __invoke()
  • Пример #5 Пример использования __invoke()

В Английской версии оба называются "Using __invoke()"

Я предлагаю все заголовки привести к единообразию и использовать шаблон "Использование __sleep() и __wakeup()".

@saundefined
Copy link
Member

Я тоже за 4 вариант, спасибо!

Мне кажется избыточным добавления слова "пример" в начале, потому что во время рендинга, перед заголовком добавляется префикс "Пример №1" https://www.php.net/manual/ru/language.oop5.magic.php#example-796

В #256 есть предложение по унификации заголовков примеров на «Пример использования ...», хотя в примере речь о функции, неплохо было бы привести к однообразию все заголовки:
«Пример использования <функции/метода/константы/языковой конструкции/и т. д.> <сущность>».

@saundefined saundefined added the Улучшение документации Качество и улучшение документации label May 28, 2024
@RuZniki
Copy link
Contributor Author

RuZniki commented May 28, 2024

Обновил заголовок первого пример.

@RuZniki RuZniki changed the title Изменения название первого примера Исправление названия примеров в магических методах May 28, 2024
Copy link
Member

@saundefined saundefined left a comment

Choose a reason for hiding this comment

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

Спасибо!

@saundefined saundefined merged commit 12a9d55 into php:master May 29, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Улучшение документации Качество и улучшение документации
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants