Skip to content

Update UnitTestBot Python, JavaScript, Go docs #1989

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

Merged
merged 4 commits into from
Mar 27, 2023

Conversation

olganaumenko
Copy link
Collaborator

Description

Linguistic bugs fixed, document structure optimized.
Added note: "be sure to enable Experimental languages support option for each project".

How to test

The PR introduces no code changes.
Manual scenario: the text itself has been previewed in the IntelliJ IDEA viewer.

Self-check list

  • I've set the proper labels for my PR (at least, for category and component).
  • PR title and description are clear and intelligible.
  • I've added enough comments to my code, particularly in hard-to-understand areas.
  • The functionality I've repaired, changed or added is covered with automated tests.
  • Manual tests have been provided optionally.
  • The documentation for the functionality I've been working on is up-to-date.

@olganaumenko olganaumenko added ctg-documentation Improvements or additions to documentation comp-ui Improvements of plugin UI appearence and functionality comp-cli Issue related to CLI lang-python Issue is related to python support lang-javascript Issue is related to JavaScript support lang-go Issue is related to Go support labels Mar 20, 2023

# Get started
1. Python 3.8 or 3.9 (UnitTestBot Python has been tested to provide support for these versions; some Python 3.10 syntax is not supported)
Copy link
Member

Choose a reason for hiding this comment

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

Now we support Python 3.8+.


UTBot Python has been tested on Python 3.8 and 3.9. Some syntax from Python 3.10 is not supported.
To try UnitTestBot Python as an _**IntelliJ IDEA plugin**_:
1. Download the corresponding [archive](https://github.com/UnitTestBot/UTBotJava/actions/runs/2956160534).
Copy link
Member

Choose a reason for hiding this comment

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

This instruction is outdated. Now UTBot Python is included in UTBot Java plugin.


#### Requirements
### Requirements

* Java SDK 11 or later
* Go SDK 1.18 or later
* Properly configured `go.mod` file for the code under test
* GCC as well as `github.com/stretchr/testify/assert` and `golang.org/x/tools@v0.4.0` Go modules installed
Copy link
Collaborator

Choose a reason for hiding this comment

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

golang.org/x/tools@v0.4.0 is not required


1. Python 3.8 or later
2. [Python plugin](https://plugins.jetbrains.com/plugin/631-python) for IntelliJ IDEA
3. IntelliJ IDEA 2022.1
Copy link
Member

Choose a reason for hiding this comment

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

Now this line is not needed

Copy link
Member

@alisevych alisevych left a comment

Choose a reason for hiding this comment

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

LGTM, just minor corrections are possible.

@olganaumenko olganaumenko merged commit ec26f59 into main Mar 27, 2023
@olganaumenko olganaumenko deleted the olganaumenko/experimental_languages_support_docs branch March 27, 2023 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp-cli Issue related to CLI comp-ui Improvements of plugin UI appearence and functionality ctg-documentation Improvements or additions to documentation lang-go Issue is related to Go support lang-javascript Issue is related to JavaScript support lang-python Issue is related to python support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants