This repository has been archived by the owner on Oct 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 226
Fix confusion about IDE breaking changes #1229
Merged
Merged
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
Closed issue microsoft#994 (and presumably others) indicate that the confusing version text referring to 1.8.7 will be corrected, but that never happened. This PR attempts to improve the text to correct the issue.
adiazulay
approved these changes
Apr 12, 2021
adiazulay
added a commit
that referenced
this pull request
Apr 20, 2021
* Option to use arduino-cli instead of Arduino IDE (#1017) * Hardcoded Arduino-CLI commands for build and upload * Added menu checkbox for Arduino CLI - Upload with programmer is still not supported - Must be created an arduino symlink pointing to arduino-cli * If Arduino-CLI, check for arduino-cli instead of arduino. Not yet supported on Windows or MacOS * Typo * Fixed CI requests * Fixed CI requests * Update src/common/sys/darwin.ts MacOS patch for arduino-cli Co-authored-by: Marc Lage-Vianna <[email protected]> * Update src/common/sys/win32.ts Windows patch for arduino-cli Co-authored-by: Marc Lage-Vianna <[email protected]> * Trigger * add cli option in commandPath for win32 * add cli support to board and lib managers * rename isArduinoCli to useArduinoCli * adds support for uploading using programmer * simplify getProgrammer * add CLI upload * Update src/arduino/arduino.ts Co-authored-by: Jason Tranchida <[email protected]> * refactor uploadUsingProgrammer * fix output path for CLI upload * Update package.json * update cli option text, thanks @maddogjt * update tests Co-authored-by: giuliof <[email protected]> Co-authored-by: Marc Lage-Vianna <[email protected]> Co-authored-by: Adi Azulay <[email protected]> Co-authored-by: Adi Azulay <[email protected]> Co-authored-by: Jason Tranchida <[email protected]> * Improved handling of programmer selection (#1118) * Improved handling of programmer selection - Selected programmer is now saved to and loaded from the arduino.json file - Arduino.json is monitored for changes, and changing file will update selected programmer & ui - Programmer selection UI now shows both the friendly name of the programmer, as well as the arduino name - Minor fix to deviceContexts to fire change events after all states are modified - Layed groundwork to support querying list of programmers for the current board from arduino toolchain * fix dtr on serial open * fix dtr on serial open * fix linting * pre release v0.3.4 * Add RTS signal on serial open, Add baudrates up to 2000000 (#1142) * add buad rates up to 2M * add rts signal on serial open and buad rate change * add missing space in baud rate array * Quick fix for Intellisense (#1144) * add hardware tool path * intellisense quick fix * add hardware tool path * intellisense quick fix * fix typo * pre release v0.3.4-rc2 * bump to v0.3.4 * Option to use arduino-cli instead of Arduino IDE (#1017) * Hardcoded Arduino-CLI commands for build and upload * Added menu checkbox for Arduino CLI - Upload with programmer is still not supported - Must be created an arduino symlink pointing to arduino-cli * If Arduino-CLI, check for arduino-cli instead of arduino. Not yet supported on Windows or MacOS * Typo * Fixed CI requests * Fixed CI requests * Update src/common/sys/darwin.ts MacOS patch for arduino-cli Co-authored-by: Marc Lage-Vianna <[email protected]> * Update src/common/sys/win32.ts Windows patch for arduino-cli Co-authored-by: Marc Lage-Vianna <[email protected]> * Trigger * add cli option in commandPath for win32 * add cli support to board and lib managers * rename isArduinoCli to useArduinoCli * adds support for uploading using programmer * simplify getProgrammer * add CLI upload * Update src/arduino/arduino.ts Co-authored-by: Jason Tranchida <[email protected]> * refactor uploadUsingProgrammer * fix output path for CLI upload * Update package.json * update cli option text, thanks @maddogjt * update tests Co-authored-by: giuliof <[email protected]> Co-authored-by: Marc Lage-Vianna <[email protected]> Co-authored-by: Adi Azulay <[email protected]> Co-authored-by: Adi Azulay <[email protected]> Co-authored-by: Jason Tranchida <[email protected]> * Improved handling of programmer selection - Selected programmer is now saved to and loaded from the arduino.json file - Arduino.json is monitored for changes, and changing file will update selected programmer & ui - Programmer selection UI now shows both the friendly name of the programmer, as well as the arduino name - Minor fix to deviceContexts to fire change events after all states are modified - Layed groundwork to support querying list of programmers for the current board from arduino toolchain * add cli suppport for programmers * add documentation Co-authored-by: Marc Goodner <[email protected]> Co-authored-by: Adi Azulay <[email protected]> Co-authored-by: Giulio <[email protected]> Co-authored-by: giuliof <[email protected]> Co-authored-by: Marc Lage-Vianna <[email protected]> Co-authored-by: Adi Azulay <[email protected]> * Fixed misspelled function name * Fixed spelling. * Fix @Property * Add missing return values * Removed unused import * Branch for the implementation of the automagical IntelliSense configuration * Update documentation * More documentation on this project * Tried to identify most of the tasks * Added beer money support option * More documentation update * More investigations and documentation, especially on intrinsic/built-in compiler header include paths * Added IntelliSense compiler parsing engine code * Added IntelliSense compiler parsing engine code * First injection of the compiler command parser and IntelliSense auto-configuration. Currently injected into "verify" only. * Updated branch documentation to reflect the current state of this project * Improved line splitting of built-in include parser after commenting on a pull request :) * Pre-build command updates * Moved pre-build command into separate member function to reduce code replication, better maintainablility and readability * Added pre-build command to "upload using programmer" since it was (probably unintentional) missing there * Documentation updates * Notes regarding settings * Notes where to run the auto-generation * IntelliSense on/off configuration and compiler parser injection preparation * Added a global configuration switch which allows the IntelliSense auto-configuration to be turned off * Prepared the compiler parser code to be injected into "upload" and "upload using programmer" without overhead * Updated branch documentation * Added two more TODOs to branch documentation * Added even more TODOs to branch documentation * Moved TODO in branch documentation * Documenting ... * Moved compiler parser to cocopa package for better testability and maintainability * Updated earned 🍻 * Added IntelliSense setup auto-generation project (sketch-context) configuration flag which can override the global flag * Try to generate IntelliSense configuration even when the compilation fails * Incorporated the latest progress from cocopa development * Fix issue 771 * Fixes the line splitting regex as outlined in #771 * Removed a redundand condition * Fix regression and improve regex matching * Fixed regression introduced with adaptions to latest version of cocopa * Made compile command regex match more stringent * Notes about serial monitor * Added more serial monitor ideas from [John Lonergan](#463 (comment)) * Added some ideas how to implement a better serial monitor * Moved arduino specifics from cocopa to vscode-arduino * Merge c_cpp_properties results with existing configuration * More unit testing within cocopa. * Implemented c_cpp_properties merging -> compiler analysis results are merged into existing configuration and will preserve configurations of different name than the vscode-studio default configuration name (currently "Arduino"). This opens up the possibility for users to write their own configurations without having to disable the autogeneration. * Implemented "write on change" - `c_cpp_properties.json` will only be written if a new configuration has been detected. * Minor documentation rub * Moved intellisense function to a separate file * Added instructions how to run development code * More on beta testing, added link to chat room * Note how to run vscode without having gulp on your user path * Updated beer money log * Updated branch notes -- documented changes not committed though. * Rename Logger to logger * Rename verifyResult to success * Move args variable till top of upload, uploadUsingProgrammer and verify * Introduce verbose variable * Unify util.spawn invocation * Unify exit error message * Add cleanup expression * Add selectSerial expression * Inline and move appPath later * Move arg buildup earlier in functions * Move selectProgrammer down * Spelling correction * Add buildMode argument to upload and uploadUsingProgrammer * Make upload and uploadUsingProgrammer identical * Merge upload and uploadUsingProgrammer into one build function * Add buildMode argument to verify * Add stdoutCallback expression * Rename output to buildDir * Use cocopa and add Analyze build mode * Make build return boolean * Make build and verify identical * Merge build and verify * Add arduino.rebuildIntelliSenseConfig * Fix whitespace * Disabled and marked all previous implementations of IntelliSense support for later removal using `IS-REMOVE` * Updated project log * Don't use hard coded paths when possible. * New classes which will improve the device settings management and event handling. To be integrated with one of the next commits. * Updated log and issues * Added/documented all known related issues * Updated log * Updated and extended status * General brushing of structure and text * Updated project log and status * Updated and completed documentation of the current state within README.md * Updated project log and status * IntelliSense auto-analysis integration * Reworked DeviceContext for fine grained event generation on settings change * Added dedicated settings classes which allows for the latter * Changed board manager and serial monitor to used the new fine grained events instead of the "something changed event" - which makes the code marginally more efficient * Implemented an analysis manager which takes care of analysis requests generated by settings change events and makes sure that analysis builds don't interfere with regular builds * Adapted the build infrastructure within ArduinoApp such that it allows for the above * Removed the global build guard and moved it to ArduinoApp (there is a corner case though for programmer selection within extension.ts which I marked with a TODO * Fixed some linting issues but did not lint most of the stuff committed here - this will be part of a later commit * I left notes here and there where I saw things which should/could be improved/changed * Removed the try/catch guards from the build invocations within extension.ts since exceptions are handled within the build function itself * Changed the project setting parameter for the IntelliSense setup to reflect its workings better * Updated log and beers. * Added "some" additional issues -- currently I've found 28! * Updated log, status and beers * Removed obsolete doc folder as all this is now part of cocopa * Fixed handling of invalid manual configurations. Improved code locality for board configuration manipulation and fixed a race condition with fine grained event handling. Details: Added missing checks when board configurations are loaded from the configuration file: * Up to now vscode-arduino blindly loaded any board configuration from `arduino.json` even if this would result in invalid board configurations which in turn lead to compilation (verify, upload) failure. * Up to now this state couldn't be recovered by simply removing the offending configuration from the configuration file. Even worse: it stored the wrong configuration in between board changes. To reproduce the bug in 0.2.29 1. Select Arduino Nano with the *Arduino Board Configuration* 2. Set configuration in `arduino.json` to `cpu=cray2` and save 3. Verify -> fails 4. Switch board to Arduino Uno 5. Switch back to Arduino Nano: The wrong configuration is back and now the user can't even select another (correct) configuration from the *Arduino Board Configuration* window 6. Delete the wrong configuration and save -> verify still fails `vscode-arduino` does not fall back to a default configuration. The user has now two options: find the correct configuration by himself and set it within arduino.json. Very experienced users could probably accomplish that. Everone else can just restart vscode. I corrected that by enhancing IBoard.loadConfig and IBoard.updateConfig member functions to * check for proper formatting of the config string loaded from `arduino.json` * check if the configuration IDs and the option IDs are valid If any of the above fails, the functions bail out and return the error. The board manager then loads a default configuration and issues a warning, that the configuration is invalid. This way the user gets the chance to fix her/his configuration but gets informed at the same time, that a different configuration than the intended is loaded (prevents surprises). This situation is only relevant, when users start fiddling with the configuration values in `arduino.json`. As long as they just set the board and the configurations from within the *Arduino Board Configuration Window* nothing bad can happen. But now custom configurations are handled in a cleaner way. The DeviceContext's board configuration was set in board.ts and boardManager.ts in different places - even when it was loaded after a DeviceContext's configuration update event which is prone to infinite loops. This has been resolved and it's not re-written/re-set during loading a configuration on change. This is valid for board manager's updateStatusBar function which fiddled with the board and the configuration. Now updateStatusBar really just updates the status bar. And it isn't necessary to call it from outside the board manager anymore due to proper event handling which identifies the situations during which the status bar has to be updated. Therefore this member is now private. In board manager itself operations that affect device context and current board now happen only within doChangeBoardType and the event handlers of DeviceContext callbacks onDeviceContextConfigurationChange and onDeviceContextBoardChange. This prevents the accidental creation of infinite event loops, makes the code more understandable, maintainable and therefore resilient against future bugs. * Updated log and beers * Updated to latest cocopa which features X-platform support and better lexer * IntelliSense config generator * Now normalizes generated include paths * Bumped cocopa to 0.0.9 * Updated log * Updated branch log and beers * Forceinclude Arduino.h * Added message to end of each build to inform user how to update the IntelliSense configuration * The magic now searches all identified include paths for the Arduino core include file (aka Arduino.h) and adds it as forced include - most users expect Arduino core functionality to work without having to include this header. Added typed-promisify to dependencies since I made use of it in the new code for better readability. * Conclude is now asynchronous * Updated branch status and added new future task * Bumped cocopa version to 0.0.10 * Updated log and beers * Updated cocopa to version 0.0.12 * Implemented and tested support for `.cpp`-sketches. * Done implementing the most relevant unit tests in cocopa. * Two independent alpha testers confirmed proper working of the previous alpha releases. * Updated to the latest revision of cocopa. * Removed IS-REMOVE code * Removed code marked with `IS-REMOVE` previously * Added constant for the `c_cpp_properties.json`-configuration managed by vscode-arduino * Removed code rendered dead by the previous removal * Reworked util.spawn to mergable version * Added/reviewed some notes * Changed Serial.updatePortListStatus to make use of optional argument to eliminate updatePortListStatus(null) calls * Refined some documentation comment * Updated log * Final pull request dependency style for cocopa * Updated beers * Added link to alpha releases to top of document * Run IntelliSense analysis for every build * Run IntelliSense analysis for every build * Added global enum for log level * Build/analysis logging improvements * Fixed bug in board.ts: Conceptual flaw when checking if configuration option is valid * Fixed exception which occurs if one of the include directories doesn't exists and we try to search it for Arduino.h * Filter out invalid include directories * Filtering out invalid include directories (discovered when compiling for ESP8266) * Compacted IntelliSense message and hint to manual build into a single line * Make upload verbosity be conditional and extend filtering * Building always verbosely but upload only verbosely when requested * Filtering of spurious messages now with regex list and for all platforms * Collapsing multiple consecutive newlines into a single newline for non verbose build log * IntelliSense auto gen respected global and project specific dis-/enable flags for analyze only. Now these flags have the same effect during regular builds. * Added post build command support * Added post build command support * Added validator for both pre and post build (former was missing) Yet to be decided: Solution for analysis run: with or without pre/post build? Addresses #786 * C++ standard is now parsed from compiler arguments Plus: Moved some methods to cocopa and got rid of the typed-promisify dependency * Section which outlines additional features this branch addresses * Logging and post-build commands * Error logging for exceptions during build cleanup * Compacted log message filter regexes * Moved pre-build command after initialization of the output folder in case this command somehow wants to operate on it somehow * Better error message handling when post-build command fails * Forwarding post-build command error * Pre-/post-build command improvements * Full bash syntax support for pre-/post-build commands on UNIX systems * Environment variables for pre-/post-build commands which give the user access to several build process parameters like the sketch, the output directory, serial port, build mode (verify, upload, analyze, ...), board type and workspace path Addresses #786 * Full cmd support for pre-/post-build commands on Windows Addresses #786 * Documentation for pre-/post-build commands and their environment variables * Updated log, status and beers * Fix too early initialization of cocopa * Fixed bug with build: initializing cocopa too early (was failing if sketch wasn't initialized) * More info in error message for uncaught exception during build cleanup * Note on output path preparation which seems to be a bit wonky * Support for Arduino preferences in `arduino.json`. These preferences are applied during any build and can be used to set custom compiler flags and defines for instance. Addresses #975 * Add and document buildPreferences setting * Validator for `buildPreferences` * Documentation for `buildPreferences` * Fixed security issue * Web-server for library-, board-manager etc. was not listening on localhost but on the machine's main interface * Web-server wasn't launched asynchronously what can cause problems * Port was stored redundantly in webserver class Addresses #966 * Updated log, additional stuff and beers * Move the _build to the end and make private * Consolidate all boardDescriptor argument pushing * Remove compile argument and expand BuildMode with CliUpload and CliUploadProgrammer * Reverse and merge tests * Replace "upload" with "compile --upload" * Join args.push statements * Remove arrow-head anti-pattern * add support for cli * fix cli analyze mode * fix verbose setting and cli programmer upload * remove redundant prebuild check * update travis * fix missing " * Populate the list of programmers by parsing programmers.txt for each package (#1129) * Improved handling of programmer selection - Selected programmer is now saved to and loaded from the arduino.json file - Arduino.json is monitored for changes, and changing file will update selected programmer & ui - Programmer selection UI now shows both the friendly name of the programmer, as well as the arduino name - Minor fix to deviceContexts to fire change events after all states are modified - Layed groundwork to support querying list of programmers for the current board from arduino toolchain * Parse the list of programmers from packages * Tests for parsing programmers * Show board specific list of programmers when selecting Populate the selected programmer and it's display name using list of programmers provided by BoardManager. When selecting programmer, only present the user a list of programmers relevant to the current board. * Initial set of tests for ProgrammerManager * add support for cli * fix hardcoded package name for programmers * adds programmer.key back to support arduino IDE * fix handeling of programmer name in ide and cli Co-authored-by: Adi Azulay <[email protected]> * Bump ini from 1.3.5 to 1.3.8 (#1159) Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.8. - [Release notes](https://github.com/isaacs/ini/releases) - [Commits](npm/ini@v1.3.5...v1.3.8) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adi Azulay <[email protected]> * remove IntelliSense Auto branch notes * remove -MMD from complier args for intellisesne (#1208) * Squashed commit of the following: commit 57c8d2d Author: Adi Azulay <[email protected]> Date: Mon Mar 22 13:00:21 2021 -0700 update changelog commit 6e65997 Author: Adi Azulay <[email protected]> Date: Mon Mar 22 12:49:56 2021 -0700 bump to v0.4.0 commit 6d63a01 Author: Adi Azulay <[email protected]> Date: Tue Mar 9 08:54:05 2021 -0800 update version commit ed886ad Merge: 6ecfc55 9ca2400 Author: Adi Azulay <[email protected]> Date: Mon Mar 8 14:01:55 2021 -0800 Merge branch 'develop' into pre-release-v0.4.0 commit 6ecfc55 Author: Adi Azulay <[email protected]> Date: Thu Feb 18 11:27:45 2021 -0800 update version in package commit 1126581 Author: Adi Azulay <[email protected]> Date: Thu Feb 18 11:07:59 2021 -0800 update readme commit 5571e52 Author: Adi Azulay <[email protected]> Date: Thu Feb 18 10:52:24 2021 -0800 update package-lock commit 0b60f1f Merge: e044711 e97bad8 Author: Adi Azulay <[email protected]> Date: Thu Feb 18 09:59:26 2021 -0800 Merge branch 'master' into pre-release-v0.4.0 commit e97bad8 Author: Adi Azulay <[email protected]> Date: Thu Feb 18 09:56:05 2021 -0800 bump to v0.3.5 (#1196) * update usb native * update changelog * fix ref tag for publishing * fix ref tag for publishing * change build to check version env var * fix version spelling * add {} to if in publish * change version check to regex * fix formatting * change to multiline run * add echo for ISPRODUCTION * add missing s to outputs * remove debugging echo commit e044711 Merge: 739aa95 5f4c400 Author: Adi Azulay <[email protected]> Date: Thu Feb 4 14:32:52 2021 -0800 Merge branch 'develop' of https://github.com/microsoft/vscode-arduino into pre-release-v0.4.0 commit 739aa95 Author: Adi Azulay <[email protected]> Date: Thu Feb 4 14:21:55 2021 -0800 pre release v0.4.0 * Quick pick selection of sketch files (#1128) * Quick pick selection of sketch files - Replace arduino.setSketchFile command with new arduino.selectSketch command which presents the user with a quick select containing all of the sketch files in the workspace. - Add "Arduino: Select Sketch" to the command palette - When picking sketches, filter out hardware, library, and build folders that may be under the workspace * Fix incorrect slash on library exclude pattern Co-authored-by: Adi Azulay <[email protected]> * Corrected typo from Ardiuno to Arduino. (#1191) Co-authored-by: Adi Azulay <[email protected]> * Fix arduinoPath resolution on MacOS (#1227) * Fix arduinoPath resolution in MacOS. The `resolveMacArduinoAppPath` utility was automatically adding "Arduino.app" to the resolved `arduinoPath` regardless of whether `useAndroidCli` was enabled. This was breaking installations of `arduino-cli` made through Homebrew. The path to the command ends up being either `/usr/local/bin/arduino-cli` or `/opt/homebrew/bin/arduino-cli`. This function would resolve an `arduinoPath` of `/opt/homebrew/bin` to `/opt/homebrew/bin/Arduino.app/arduino-cli`. Co-authored-by: Adi Azulay <[email protected]> * Bump y18n from 3.2.1 to 3.2.2 (#1219) Bumps [y18n](https://github.com/yargs/y18n) from 3.2.1 to 3.2.2. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adi Azulay <[email protected]> * Fix confusion about IDE breaking changes (#1229) Closed issue #994 (and presumably others) indicate that the confusing version text referring to 1.8.7 will be corrected, but that never happened. This PR attempts to improve the text to correct the issue. Co-authored-by: Adi Azulay <[email protected]> * Fix typos in CHANGELOG.md (#1226) Co-authored-by: Adi Azulay <[email protected]> * Fix typos in README.md (#1225) Co-authored-by: Adi Azulay <[email protected]> * Bump y18n from 4.0.0 to 4.0.1 in /src/views (#1220) Bumps [y18n](https://github.com/yargs/y18n) from 4.0.0 to 4.0.1. - [Release notes](https://github.com/yargs/y18n/releases) - [Changelog](https://github.com/yargs/y18n/blob/master/CHANGELOG.md) - [Commits](https://github.com/yargs/y18n/commits) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adi Azulay <[email protected]> * Bump elliptic from 6.5.3 to 6.5.4 (#1212) Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.3 to 6.5.4. - [Release notes](https://github.com/indutny/elliptic/releases) - [Commits](indutny/elliptic@v6.5.3...v6.5.4) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adi Azulay <[email protected]> * Bump elliptic from 6.5.3 to 6.5.4 in /src/views (#1210) Bumps [elliptic](https://github.com/indutny/elliptic) from 6.5.3 to 6.5.4. - [Release notes](https://github.com/indutny/elliptic/releases) - [Commits](indutny/elliptic@v6.5.3...v6.5.4) Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Adi Azulay <[email protected]> * add usbcon macro to config (#1231) * add ai key to deploy (#1236) * Bump to v0.4.1 (#1238) * pre-release v0.4.1-rc1 * pre-release v0.4.1-rc2 * update version * bump to v0.4.1 Co-authored-by: Giulio <[email protected]> Co-authored-by: giuliof <[email protected]> Co-authored-by: Marc Lage-Vianna <[email protected]> Co-authored-by: Jason Tranchida <[email protected]> Co-authored-by: Marc Goodner <[email protected]> Co-authored-by: Uli Franke <[email protected]> Co-authored-by: Håkon Løvdal <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Cameron Bielstein <[email protected]> Co-authored-by: Adam Michel <[email protected]> Co-authored-by: mikebaz <[email protected]> Co-authored-by: jogo- <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closed issue #994 (and presumably others) indicate that the confusing version text referring to 1.8.7 will be corrected, but that never happened. This PR attempts to improve the text to correct the issue.