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

Add warning message to Windows installation section #1257

Merged
merged 5 commits into from
Jan 23, 2024

Conversation

tkumor3
Copy link
Contributor

@tkumor3 tkumor3 commented Jan 18, 2024

Closes #1173

Adds a warning to instructions on how to install starnet.py on Windows

  • This PR contains breaking changes

Zrzut ekranu 2024-01-19 o 12 11 00

@tkumor3 tkumor3 changed the base branch from master to development January 18, 2024 15:45
Copy link

codecov bot commented Jan 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (580493c) 98.00% compared to head (a0c7a08) 98.00%.

Additional details and impacted files
@@             Coverage Diff              @@
##           development    #1257   +/-   ##
============================================
  Coverage        98.00%   98.00%           
============================================
  Files               89       89           
  Lines             4506     4506           
============================================
  Hits              4416     4416           
  Misses              90       90           

Copy link
Member

@THenry14 THenry14 left a comment

Choose a reason for hiding this comment

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

lgtm, but let's wait with merge for @ddoktorski

docs/installation.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@ddoktorski ddoktorski left a comment

Choose a reason for hiding this comment

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

Apart from a small nitpick about rephrasing, would you mind formatting the PR titles (and therefore commit messages in the development branch) to start with a capital letter and be in the imperative mood? Also, it would be great if we could include a 'Closes...' directive in the PR's description.

Co-authored-by: ddoktorski <45050160+ddoktorski@users.noreply.github.com>
@tkumor3 tkumor3 linked an issue Jan 23, 2024 that may be closed by this pull request
@tkumor3 tkumor3 changed the title adds warning about most common problem with installation on windows Closes #1173 adds warning about most common problem with installation on windows Jan 23, 2024
@tkumor3 tkumor3 changed the title Closes #1173 adds warning about most common problem with installation on windows Adds warning about most common problem with installation on windows Jan 23, 2024
@tkumor3 tkumor3 changed the title Adds warning about most common problem with installation on windows Add a warning about the most common problems encountered during installation on Windows. Jan 23, 2024
@tkumor3 tkumor3 changed the title Add a warning about the most common problems encountered during installation on Windows. Add a warning about the most common problems encountered during installation on Windows Jan 23, 2024
@tkumor3 tkumor3 changed the title Add a warning about the most common problems encountered during installation on Windows Add warning message to Windows installation section Jan 23, 2024
docs/installation.rst Outdated Show resolved Hide resolved
@tkumor3 tkumor3 merged commit a999cd0 into development Jan 23, 2024
14 checks passed
@kkawula kkawula deleted the 1173-update-windows-install branch August 26, 2024 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Windows installation section in docs
3 participants