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

Описание параметра оформить в виде таблицы #50

Closed
sergey-s-betke opened this issue Jan 2, 2013 · 5 comments
Assignees
Milestone

Comments

@sergey-s-betke
Copy link
Member

Сейчас описание параметра выглядит следующим образом:

  • TranslateRules <Array>
    Правила для обработки readme регулярными выражениями

    Требуется? false
    Позиция? named
    Значение по умолчанию
    Принимать входные данные конвейера?false
    Принимать подстановочные знаки?
    

Целесообразно оформить следующим образом:

  • TranslateRules <Array>
    Правила для обработки readme регулярными выражениями

    Требуется?false
    Позиция?named
    Значение по умолчанию
    Принимать входные данные конвейера?false
    Принимать подстановочные знаки?
@ghost ghost assigned sergey-s-betke Jan 2, 2013
@sergey-s-betke
Copy link
Member Author

Однако, "читабельность" текстового файла при этом существенно страдает. Возможно, подобное оформление имеет смысл использовать только по соответствующему флагу.

@sergey-s-betke
Copy link
Member Author

Для этого до описания параметров добраться можно так:

( $FunctionInfo ).Parameters.Values

sergey-s-betke added a commit that referenced this issue Oct 7, 2013
…ьзования форматов по умолчанию (в рамках #50), но ещё без поддержки локализации
@sergey-s-betke
Copy link
Member Author

Потребуется чтение локализованных ресурсов сборок PowerShell:

$asm = [System.Reflection.Assembly]::Load('System.Management.Automation')
$rm = New-Object -Type 'System.Resources.ResourceManager' -ArgumentList 'HelpDisplayStrings', $asm
$rm.GetString('AcceptsPipelineInput')

чтобы получить все ресурсы сборки:

$rs = $rm.GetResourceSet( ( Get-UICulture ) , $true, $true )
$rs

@sergey-s-betke
Copy link
Member Author

В принципе, задача решена именно так, как и поставлена - таблицу сформировал (комит выше). Однако - в таблицах не раскрываются концевые сноски! Да и оформление таблиц слишком громоздко выглядит как в текстовом файле, так и после конвертации в html в дизайне github. Посему имеет смысл подумать о вложенных списках, а не о таблицах...

@sergey-s-betke
Copy link
Member Author

Остановился на варианте со списком. Такой вариант выглядит куда более читабельно как в случае простого txt файла, так и в случае html, полученного по .md файлу.

Данный вопрос на этом закрываю. Выбирать прочие форматы для генерации описаний можно через реализацию и использование собственных форматов (#68).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant