Using Structured Documentation for Signature Help and improving Parameter Documentation #1958
+158
−7
Conversation
This file contains 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
|
With this change, the signature help now appears like |
rchande
approved these changes
Jan 12, 2018
| private GetParameterDocumentation(parameter: SignatureHelpParameter) { | ||
| let summary = parameter.Documentation; | ||
| if (summary.length > 0) { | ||
| let nameInBold = "**" + parameter.Name + "**" + ": "; |
src/omnisharp/protocol.ts
Outdated
|
|
||
| export interface DocumentationComment { | ||
| SummaryText: string ; | ||
| TypeParamElements :DocumentationItem[]; |
src/omnisharp/protocol.ts
Outdated
| } | ||
|
|
||
| export interface DocumentationComment { | ||
| SummaryText: string ; |
rchande
reviewed
Jan 12, 2018
| @@ -49,7 +49,7 @@ export default class OmniSharpSignatureHelpProvider extends AbstractSupport impl | |||
| private GetParameterDocumentation(parameter: SignatureHelpParameter) { | |||
| let summary = parameter.Documentation; | |||
| if (summary.length > 0) { | |||
| let nameInBold = "**" + parameter.Name + "**" + ": "; | |||
| let nameInBold = `**${parameter.Name}**: `; | |||
rchande
approved these changes
Jan 12, 2018
|
Yes we can merge this on a new release of omnisharp. |
DustinCampbell
approved these changes
Jan 23, 2018
rchande
reviewed
Feb 21, 2018
| }); | ||
|
|
||
|
|
||
| test("Returns response with documentation as undefined when method does not have documentation", async function () { |
There was a problem hiding this comment.
There are two types of tests we should be thinking about:
- Unit tests, which test the specifics of the C# extension's signature help implementation. These tests should theoretically be able to run outside of VS Code and shouldn't need to send VS Code commands
- Integration tests, which verify that the C# extension's signature help is hooked up in VS Code and validate any nuances there (eg, trigger characters, etc). By definition, these tests run in VS Code.
Today, we can only test features by writing "integration" tests. At some point, we should think about what we'll need to do to write "unit" tests to test these kinds of implementation details. Not blocking your PR on this, but something to consider (cc @TheRealPiotrP ).
rchande
reviewed
Feb 21, 2018
| expect((<vscode.MarkdownString> c.signatures[0].parameters[1].documentation).value).to.equal(param2); | ||
| }); | ||
|
|
||
| test("Signature Help identifies active parameter if there is no comma", async function () { |
There was a problem hiding this comment.
Nice! BTW, where did these tests come from?
There was a problem hiding this comment.
I wrote them myself.
rchande
approved these changes
Feb 21, 2018
akshita31
added a commit
to akshita31/omnisharp-vscode
that referenced
this pull request
Feb 23, 2018
…eter Documentation (dotnet#1958) * Structured Documentation in Signature Help * Code clean up * Using only summary of the documentation * Code clean up * Documentation for parameters showing in signature help * Removing unnecesaary import * Using interploated string and fixed spacing * Parameter Documentation using interpolated text * Added tests
TheRealPiotrP
pushed a commit
that referenced
this pull request
Apr 27, 2018
* Initial manual validation plan * Add info about unity * Enable usage of omnisharp.path option for downloading multiple versions of omnisharp (#2028) * Enable usage of multiple versions * Either load the server from a path or download the version packages * Tests for the package creator * Added null check and removed semver check in package creator * Test for the experiment omnisharp downloader * Added test for package manager * Code clean up * Added null or empty check for version * Changes * Modified the description Put the clean up logic in the teardown function * Remove comment * Remove unnecessary usage * CR comments * Removed experimental * Modified launcher * Removed experimental * Modified tests * Modified package description to include version information * Renamed launch path * Add more tests * Changed the description in package.json * "Run All Tests" and "Debug All Tests" (#1961) * Run All Tests Running But Building repeatedly * Disposable variable for run all test * Added code for debug all tests * Code Cleaning * Run all Tests running - Better logs required * Run Tests running, all output shown at the end of all the tests * Renamed variable to methodsInClass * Changes for Debug All Tests * Changes for debug tests request * Debug All Tests running * Added common helpers for single test and all test functions * Improved logs for Run All Tests * Changes to get only 1 response for a set of methods * Extracted a common helper to get the test feature * Resolved review comments * Changes to not show this change for legacy projects * Renamed incorrect variable * Removing foreach for proper order of execution * Remove unnecessary import * Do not show the festure for legacy projects * Make hover test run by adding the file in the project (#2058) * Added hover.cs file * Not requiring server restart * Using Structured Documentation for Signature Help and improving Parameter Documentation (#1958) * Structured Documentation in Signature Help * Code clean up * Using only summary of the documentation * Code clean up * Documentation for parameters showing in signature help * Removing unnecesaary import * Using interploated string and fixed spacing * Parameter Documentation using interpolated text * Added tests * Enable download and usage of latest version of omnisharp (#2039) * Enable usage of multiple versions * Either load the server from a path or download the version packages * Tests for the package creator * Added null check and removed semver check in package creator * Test for the experiment omnisharp downloader * Added test for package manager * Code clean up * Added null or empty check for version * Changes * Modified the description * Put the clean up logic in the teardown function * Remove comment * Remove unnecessary usage * CR comments * Removed experimental * Modified launcher * Removed experimental * Modified tests * Modified package description to include version information * Renamed launch path * Add more tests * Changed the description in package.json * Getting latest version info * Refactored code and added tests * Remove unnecessary using * CR comments * Use common function for latest download * Add new line * Resolve binaries on linux * Copy pacakges by value * Renamed experimentalId and some methods * Moved status item out of method and added version to message * Fix typo (#2066) * Fix year in changelog (#2068) Fixed wrong year in changelog * Formatting for better display structure * Move to const fields in server * Make methods private * Move chai-as-promised to devDependencies * Removed unnecessary function * Insert new debugger with support for Symbol Server and Source Link (#2070) * launch.json schema changes and documentation This has the new launch.json schema to support XPlat symbols * Update debugger packages * Update CHANGELOG.md with debugger change * Modified test description * Update .editorconfig JSON rules (#2063) Last week I ran into yet another time when something added a BOM to one of our json files and broke things. This adds some .editorconfig rules for .json to try and prevent such things. While I was at it, I also wanted to switch the indent size for src/tools/*.json to be '2' so that it is consistent with other json schema files the debugger owns. * Updated to reflect limited Desktop CLR support (#2046) * Updated to reflect limited Desktop CLR support * Fixed grammatical error * Refactor CSharpExtDownloader to use the extracted helper functions (#2072) * Refactor downloader * Renamed method and corrected the position of appendLine * Modified GetStatus and the Status object to append the dispose method * Added settings file * Emphasize test codelens * Add another bullet point * Add more details about signature help and tests codelenses * Fix typo * Update Changelog and test-plan for multiple download of omnisharp (#2082) * Update changelog and test-plan for multiple download of omnisharp * Add mocha+wallaby tests (#2091) * Add mocha+wallaby tests eventually the feature tests should be removed and most of our tests should become unit tests that are runnable from the command line or via wallaby. npm run tdd will enable using mocha's command line tdd capability * Fix `tdd` command * Fix test paths * move to tslint-no-unused-expression-chai The package was already installed, but not used. This makes our tests that use chai.should() pass tslint checks * Add Architecture check in AdapterExectuableCommand (#2094) * Add Architecture check in AdapterExectuableCommand x86 messages only show during the first installation. But it still registeres the vsdbg-ui.exe command. This adds a check so it will error instead of returning the command. * Moving arch check into completeDebuggerInstall * Beta1 -> Beta2 * Remove angle brackets in ChangeLog (#2099) * Add product-wide code coverage + codecov.io integration (#2101) Add product-wide code coverage + codecov.io integration Several new scripts were added: npm run cov:instrument: rebuilds your sources, then instruments them for coverage. Subsequent npm run test will generate coverage data into the .nyc_output directory npm run cov:merge-html: merges all reports from .nyc_output and puts a locally viewable coverage report into coverage directory * Refactor logger, reporter and channel into a unified EventStream using Rx Observable (#2084) * Changes to refactor logging in server * Adding packages * Changes * Remove reporter from CSharpExtDownloader * remove telemtery reporter from server.ts * remove reporter from definitionProvider * Remove reporter from dotnetTest.ts * Debugger Activation + Commands * reduce message types * remove reporter from commands.ts * remove channel from status.ts * Remove reporter & logger from extension.ts * Build issues * Add missing rx dependency * Changed to download progress * Removed using and pass platformInfo * Moved files in observer folder * Renamed the files and added omnisharp channel observer * Remove unnecessary format * Changes in main.ts * Remove channel from global declaration * Preserving the context in onNext invocations * Pulled platformInfo out of server * Remove unnecessary variable * Formatting * Renamed observers * Add mocha+wallaby tests eventually the feature tests should be removed and most of our tests should become unit tests that are runnable from the command line or via wallaby. npm run tdd will enable using mocha's command line tdd capability * Code clean up * Fix `tdd` command * Fix test paths * Add initial DotnetChannelObserver test * Testing the download messages * Remove logger from requestQueue.ts * Fix builds * Use package manager factory * Remove Lines * Remove extra appendLine * Added test for csharp logger and channel * Extracted base class for observers * Test having dependency on vscode * vscode adapter changes * Changes for adapter * Refactored Omnisharp Manager * Moved from interfaces to classes * Renamed onNext to post * Created class EventStream * Removed comment * Added missing break * Added test for Omnisharp Logger * Test for OmnisharpLoggerObserver * Test for telemetry reporter observer * Added test for all the observers * minor nits * Changes * Remove unnecessary imports * remove import * Modified failing test * Make tests pass * Renamed platformInfo * CR feedback * 2 -> 3 * Fix codecov integration (#2108) Fix js->ts coverage map transformation in Travis CI where `node` is not on the path. * enable codecov on unit tests (#2118) * enable codecov on unit tests * rename coverage files for uniform globbing * Validate Indentation for OmnisharpProcess messages (#2119) * Clean up signature help test (#2117) * Added parameter * modifications * Cleaned up tests * Changed test codelens casing (#2077) * CodeCov flags (#2125) Lights up integration test coverage and splits reporting data between unit & integration tests * Update project npm dependencies (#2126) * low-risk package updates * high-risk package updates * disable uninstrumented test pass (#2127) * Fix size (#2142) * 1.15.0-beta4 (#2143) * Verify vsix size before release (#2144) * Verify vsix size before release * Remove istanbul from shipping payload * Use the size appropriately in the release test (#2145) * Fix offline packaging using event stream (#2138) * Creating a new eventStream * invokeNode * Artifact tests * Directing the vsix files to a temp folder * Changes to travis to run release tests on release only * if statement * Convert gulpfile to ts * Add bracket * Clean up the observer tests for better readability (#2157) * CsharpLoggerObserver * dotnetchannelobserver * TelemetryObserver * DebugModeObserver * Correct message in the debug observer * Refactoring status using rxjs (#2133) * hack * Refactored status into 4 separate observers * Resolved warning and information messages * Deleted status.ts * Changes to retain this context * Created fascade for statusbar and texteditor * Subscribe to event stream * Working! * Nits * Mocking warning message * Tried mocking setTimeOut * warning message changes * warning message correct definition * virtual time running * done called multiple time * renamed observer and subject * changes * some changes * refactor^2 * merge conflicts * using rx debounce * Warning Message Observer tests * Remove loadsh.debounce and renamed observer * Move the workspace info invocation to server * Clean up * More test to statusBarObserver * Clean up tests * Fixed ttd * Use vscode commands instead of calling into commands.ts * Added test for information message observer * Tests for status bar obsever * project status observer * Changes to show two observers * some more changes * Lot of questions! * build issues * Remove usings * comments * Remove unnecessary cases * Changes * Remove usings * Dipsose the disposables after the server stop event * Remove the cake thing * Project Status Bar * Clean up the tests * Changed to dcoument * Remove unnecessary functions from the adapter * remove unnecessary change * Remove some changes * changes * Test for server error * Removed comment and modified the initialisation * Empty disposable * Corrected the usage of the disposables * Added comments for debouncer * disposable try * Test the vsix, not the build layout (#2156) The VSCode C# Extension build process follows the VS Code docs and runs tests directly inside of its repo root. This unfortunately gives a false sense of security because bugs can be introduced during VSIX packaging [particularly due to missing content in node_modules or excluded via .vscodeignore]. This change addresses this problem by moving our CI tests to execute the VSIX instead of the build's intermediate artifacts. Specifically: build the vsix unpackage the vsix instrument the unpackaged vsix run tests with VS Code Host pointing to the unpackaged vsix This makes our CI tests ~= to the user's runtime experience and will greatly help us with size reduction efforts. To support this change, I also moved our build system from package.json to Gulp. This makes the build scripts significantly easier to understand, provides intellisense for build scripts, and build-time type checking for their contents. I also strengthened the repo's use of .vscodeignore by creating a copy of the file for each scenario [online packages and offline packages]. The new gulp packaging scripts take advantage of these files to produce packages with predictable contents regardless of when packaging occurs. [small caveat, @akshita31 will be adding a test that validates that net-new content does not start sneaking into the vsix package]. * Enable `noImplicitAny` and `alwaysStrict` in `tsconfig.json (#2159) Along the way, fixed a few bugs that were in place due to implicit anys. Also removed dependency on deprecated vscode API. * tsconfig.json: noUnusedLocals, noFallThroughCaseInSwitch, tslint.json: promise-function-async (#2162) Adds noUnusedLocals to tsconfig.json to keep our sources clean Adds noFallThroughCaseInSwitch in tsconfig.json to prevent unintended switch behavior Adds promise-function-async to tslint.json to force all async functions to be marked as async. This is a building block towards eliminating promises in favor of async/await. * Eliminate Thennable<any> (#2163) Provides strong typing for the repo's Thennables. This is a step towards eliminating promises and will provide compiler support for validating that the refactored code has not changed its final return type. * promise to await packaging tasks (#2164) * Remove the status handling from the package manager (#2160) * Changes to remove status from packages.ts * Tests failing * Added tests * Used tooltip and changed flame color * fix merge problems * PR feedback * Removed implicit any * Changes * Update the links to the Source Link spec (#2170) This updates the links we had to the Source Link spec to point at the more official version. * Make the server and the downloader rely on the vscode adapter (#2167) * Moving fakes to testAssets * Change the import for fakes.ts * Test Assets in feature tests * Remove vscode dependency from server.ts * Make the downloading stuff use vscode adapter * Remove vscode as a property * make test package json a field * Run release test only on release (#2172) * Show the channel on download start (#2178) * Add "Launch Unit Test" option (#2180) * unify rx usage to rxjs (#2168) The current codebase uses both rx [v4] and rxjs [v5] implementations. This PR consolidates our use of rx onto the v5 libraries. * Fix disposable (#2189) * Divide the package manager into separate components (#2188) * Feature tests running with refactored package manager * Refactoring packages-1 * Test for the downloader running using the mock server * Using network settings * Changing the package path * Dividing packages.ts into separate components * use filter async * Use tmpfile interface * Check for the event stream * Using FilePathResolver * Remove using * Testing for normal and fallback case working * Resolve the paths * Remove failing case * package installer test-1 * Add package installer test * Create tmp asset * Package Downloader test refactored * Rename files * resolve compile issues * Clean up installer * Clean up the tests * Rename packages * Package installer test * PR feedback * Package Filter test * Remove yauzl.d.ts * Filter test * Added test for invalid zip file * method for getting the request options * remove imports * please resolve the path * remove latest in settings * Package Manager test executing * Use free port in package manager test * Package Manager (using a https server running) * using http mock server * Downloader test running using free port * Update ChangeLog for codelens and status bar (#2205) * PR feedback * Introduce OmniSharpLaunchInfo type * Fix casing of 'OmniSharp' in user-facing error message * Return both 'LaunchPath' and 'MonoLaunchPath' from OmniSharpManager * move back to latest for O# release * Refactor launcher and ensure that we launch on global Mono if possible * Improve coverage a bit * Use async/await in OmniSharpServer._start() * Fix test * Update debugger links for 1.15.0-beta5 This updates the debugger packages to the latest corelr-debug which is now built on .NET Core 2.1 Preview 2. * Update debugger changelog and debugger-launchjson.md for 1.15 (#2230) - Add debugger items to the changelog - Update debugger-launchjson.md to reference the new launchSettings.json feature. * Mark the C# extension as non-preview (#2220) * Mark the C# extension as non-preview This changes the branding on the C# extension so that it is no longer labeled a 'preview'. Two changes: 1. Change `preview` to `false` in package.json 2. Update the license that is used in official builds of the C# extension. This new EULA is no longer a pre-release EULA and it also has the latest text. * Update README.md as well
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.
Fixes : #1940
Using the structured documentation to display parsed xml in signature help. Also displaying the parameter documentation properly.
Omnisharp-roslyn side : OmniSharp/omnisharp-roslyn#1085