Multiple Vi replace methods not public
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 38/100
- issue の種類
- バグ
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- csharp, powershell
- 領域
- cli, documentation
調査の方向性
Read Replace.vi.cs around ViReplaceBrace and ReadLine.vi.cs around ViDeleteBrace, then compare those methods with the about_PSReadLine_functions documentation. Determine whether the documented methods should be public and whether their described behavior matches the implementation; done means the API and documentation discrepancy is resolved.
索引モデルが issue の本文から書いたものです。
説明
Prerequisites
- Write a descriptive title.
- Make sure you are able to repro it on the latest released version
- Search the existing issues, especially the pinned issues.
Exception report
N/A
Screenshot
Environment data
PS Version: 7.5.3
PS HostName: ConsoleHost (Windows Terminal)
PSReadLine Version: 2.3.6
PSReadLine EditMode: Vi
OS: 10.0.19041.1 (WinBuild.160101.0800)
BufferWidth: 160
BufferHeight: 42
Steps to reproduce
- Open console
- Try executing
[Microsoft.PowerShell.PSConsoleReadLine]::ViReplaceBrace()
Expected behavior
There appears to be multiple PSConsoleReadline methods listed in MS docs that are not actually public class methods. I'm focusing on ViReplaceBrace which is listed as a function in the MS docs to
Replace all characters between the current brace character and it's matching partner.
I guess there's another issue here, in that if the method was made public similar to #581 it wouldn't perform the way that it is documented. Since ViReplaceBrace calls ViDeleteBrace and that
Find the matching brace, parenthesis, or square bracket and delete all contents within, including the brace.
In vim speak that would be in vs. around.
Actual behavior
It looks like the idea behind Replace.vi.cs is to utilize the respective delete function and then change to Vi insert mode. For a lot of these private methods, that works fine and they could be easily made public to align with MS documentation.
If you'd rather I create a PR for MS docs repo to remove these private methods from the list of PSReadline functions, that works too.
- 主要言語
- C#
- スター
- 4.4k
- フォーク
- 341
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
PowerShell/PSReadLine のほかの issue
-
Needs-Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
PowerShell/PSReadLine#5205 ·
-
Needs-Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
PowerShell/PSReadLine#5195 ·
-
Needs-Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
PowerShell/PSReadLine#5121 ·
-
Needs-Triage :mag:
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
PowerShell/PSReadLine#5045 ·
-
Area-CommandHelp Issue-Enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
PowerShell/PSReadLine#3470 · リアクション 3 件 ·
PowerShell/PSReadLine の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
nightscout/nocturne#1425 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
Documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
cake-build/cake#5024 ·
-
Frontend status/draft TechnicalDebt
難易度 2/5 1〜2日 初心者へのやさしさ 75/100
Altinn/altinn-auth#4143 ·