exercism/python
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity
3,146 Commits 1 Branch 0 Tags
3a62377cb84f850c1db410e0a1f2d3a8e7816683
Commit Graph

54 Commits

Author SHA1 Message Date
Job van der Wal
c596faf219 [Docs]: Cleanup, Push to site, and Spell check (#2776) 
* Entry for TOOLS.md

* Correct links

* Spell check and cleanup

* [TESTING Docs]: Added intro and a few suggestions. (#2778)

* Add intro and a few suggestions.

* Update docs/TESTS.md

Co-authored-by: Job van der Wal <48634934+J08K@users.noreply.github.com>

Co-authored-by: Job van der Wal <48634934+J08K@users.noreply.github.com>

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
 2021-11-15 18:57:10 +01:00
Job van der Wal
69bb569c95 [TESTING.md] Enhance TESTING docs (#2611) 
* Update TESTS.md

* Update TESTS.md

* Update TESTS.md

* Start of TOOLS.md

* Finished writing VS Code part

* Added Pycharm docs & relative img links

* Update TOOLS.md

* Added Spyder Docs

* Added VENV docs

* Added conda environments docs

* Wrote Windows tutorial for adding to path

* Improved shared test file and added disclaimer to TOOLS.md

* Added docs for JupyterLab and Sublime Text

* Added Virtualenvwrapper piece.

* Cleaned up.

* Updated image paths

* Fixed Images x2

* Images have absolute path

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update exercises/shared/.docs/tests.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update exercises/shared/.docs/tests.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Fixed capitalization

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Fixed language

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>

* Update docs/TOOLS.md

* Update docs/TOOLS.md

* Update docs/TESTS.md

* Update docs/TOOLS.md

* Update docs/TOOLS.md

* Update docs/TESTS.md

Co-authored-by: Mukesh Gurpude <55982424+mukeshgurpude@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Mukesh Gurpude <55982424+mukeshgurpude@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: Mukesh Gurpude <55982424+mukeshgurpude@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: Mukesh Gurpude <55982424+mukeshgurpude@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: ynfle <23086821+ynfle@users.noreply.github.com>

* Added pytest.ini docs

* Update docs/TESTS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TESTS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update docs/TOOLS.md

Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>

* Update headers and links

Co-authored-by: Isaac Good <IsaacG@users.noreply.github.com>
Co-authored-by: Mukesh Gurpude <55982424+mukeshgurpude@users.noreply.github.com>
Co-authored-by: ynfle <23086821+ynfle@users.noreply.github.com>
Co-authored-by: BethanyG <BethanyG@users.noreply.github.com>
 2021-10-22 00:46:15 +02:00
BethanyG
2f0ffcd090 Update INSTALLATION.md 
Clarify Python versions.
 2021-10-17 15:39:21 -04:00
Matt Feifarek
adfcaf8fbb Update TESTS.md 
Just a stray parenthesis in there. nbd.
 2021-09-04 08:52:12 -07:00
BethanyG
83cc3b54ac Added one last link to pycodequa 2021-09-01 07:18:13 -07:00
BethanyG
1a470df631 Refreshed TEST docs. 2021-09-01 07:18:13 -07:00
BethanyG
2f353067f6 Refreshed RESOURCES.md 2021-09-01 07:17:36 -07:00
BethanyG
078d54c407 Updated and spiffied the LEARNING doc. 2021-09-01 07:17:19 -07:00
BethanyG
00d7b0e400 Updated INSTALLATION docs. 2021-09-01 07:17:03 -07:00
BethanyG
22fcaa8be4 Refreshed and Revised ABOUT.md for track. 2021-09-01 07:16:47 -07:00
Erik Schierboom
f53205add5 Add docs configuration 
To allow rendering the track's documents on the v3 website, we're introducing a docs/config.json file.

This commit adds the docs/config.json file.
 2021-03-19 10:43:29 -07:00
Jeremy Walker
460b14f85d Update to absolute image paths in prep for website 2021-03-19 09:16:49 -07:00
Jeremy Walker
f9d969be8f Delete HELLO.md 2021-03-19 09:15:14 -07:00
Erik Schierboom
b2dd7fb6cc [v3] Add level one headings to Markdown files. 
All Markdown files should, from this point on, start with a level one heading.
See https://github.com/exercism/configlet/issues/150 for the rationale behind these changes.

The full specification can be found [here](https://github.com/exercism/docs/blob/main/contributing/standards/markdown.md).
 2021-03-01 06:51:10 -08:00
Bobby Towers
6e4195ee37 fix broken link to pytest docs (#2183) 2020-02-26 09:45:33 +00:00
Ashley Drake
9551433827 Update tests for Bob. (#2167) 
* Generate updated tests for Bob to reflect language updates.

Relevant PRs
 - https://github.com/exercism/problem-specifications/pull/1631/files
 - https://github.com/exercism/problem-specifications/pull/1632/files

* Update docs for GENERATOR with clarification for running the script.
 2020-01-18 15:09:39 +00:00
Corey McCandless
1d90a8922b docs: update Jinja link (#2144) 
Site moved to palletsprojects.com
 2019-11-26 18:38:07 +00:00
John Luiz
6da91afb97 LEARNING.md: Remove Python 2.7 references from LEARNING.md (#1823) 2019-11-06 14:55:51 -05:00
John Luiz
8bec8659fe TESTS.md: Remove Python 2.7 references from TESTS.md (#1822) 2019-11-06 14:55:51 -05:00
Corey McCandless
78cddc9207 ABOUT.md: remove Python 2 references (#1760) 
Resolves #1699
 2019-11-06 14:55:50 -05:00
Trinh Quoc Anh
e7d833c322 Drop python 2 on docs/INSTALLATION (#1723) 
Fix #1700
 2019-11-06 14:55:50 -05:00
Corey McCandless
b965863ec9 Docs and macros improvements (#2084) 
* Document builtin template filters

* do not require explicit _has_error_case param for footer macro, but still allow it
 2019-10-22 10:56:24 -04:00
dvermd
f87bdd11d2 Fix links in documentation (#2039) 
Resolves: #2038
 2019-10-06 12:27:02 -04:00
Corey McCandless
dd698d18ef Add track Contributing Guide and Generator documentation (#1900) 
* Add Track Contributing Guide

* Add test generator documentation

* fix heading format

* fix table HTML

* incorporate review suggestions

Suggestions: https://github.com/exercism/python/pull/1900#pullrequestreview-272542702

Co-authored-by: Michael Morehouse <640167+yawpitch@users.noreply.github.com>
 2019-08-08 17:49:02 +01:00
Corey McCandless
ede3016eae Fix broken link to pytest.org (#1901) 2019-08-07 15:22:06 -04:00
Corey McCandless
ffa887156c Fix documentation heading formatting for v2 (#1420) 
* Fix documentation heading formatting for v2

* Update LEARNING.md
 2018-07-16 09:12:25 -04:00
Corey McCandless
b2f22358a5 conform ABOUT.md to formatting guidelines (#1404) 2018-06-13 08:52:24 -04:00
dog
497ab8fe21 Update Documentation For Minimum Requirements 2018-05-26 02:08:51 -07:00
Katrina Owen
23aaeafcb9 Inline the exercise README insert into the template 
Now that we have a template we don't need to have a separate README insert.
 2018-02-04 11:52:17 -07:00
Justin W. Flory
f169e30a94 Add link to PEP-373 for Python 2 EOL context (#1124) 2018-01-07 13:00:03 -06:00
Nathan Parsons
f53e2ef08b Implement checks for raising messages with exceptions (#1113) 
* Implement checks for messages being raised with exceptions
(Fixes #1080)

* Add self.assertRaisesWithMessage method to relevant exercise tests
    - Uses self.assertRaisesRegex
    - Checks only for the presence of a message, not content
* Add meaningful messages to failing examples
* octal: Switch to using a context manager for exception tests

* Add note regarding error messages to the insert

* simple-linked-list: Move hints.md to correct location

* simple-cipher: Remove extra whitespace from lines

* collatz-conjecture: Update hints.md

* Regenerate README to include exceptions section
 2017-12-12 12:11:43 -06:00
Nathan Parsons
cf4f50f4dc Update and reformat all READMEs (#950) 
* Move 'Submitting Exercises' to heading level 2

* Regenerate READMEs using configlet

* diffie-hellman: add hints.md and regenerate README

* collatz-conjecture: add hints.md and regenerate README

* simple-cipher: suggest returning a ValueError

* two-fer: Remove Test-Driven Development section
 2017-10-25 22:04:48 +01:00
Kyle Nied
6b7c4444a7 Update "TESTS.md" to show that there is a version of "pytest" for both Python2 and Python3 (#506) 
* Update TESTS.md

Provides information on the different types of "pytest" available, as well as switched "py.test" to "pytest", as recommended here (https://github.com/pytest-dev/pytest/issues/1629#issue-161422224).

* Fixed a typo.

* Small edit.

* Update TESTS.md

Cleaned it up, addressed what user "N-Parsons" commented on, fixed some errors, and added new information.

* Small Change to "PDB" Section.
 2017-10-24 22:13:34 +01:00
Katrina Owen
f7a5c3bb2d Add default introductory code example (#516) 
Instead of having logic for a fallback in the backend, we're going to
actually add a snippet.
 2017-10-01 10:48:31 +02:00
Ilya Khadykin
eca90b6a9c Updates ABOUT.md formatting for Nextercism 2017-08-12 22:21:54 +03:00
Al Sweigart
d35497ae23 Add 'Automate' book to resources list (#492) 2017-07-13 15:49:50 +02:00
Katrina Owen
8f424acdfd Rename the global exercise hints file 
We've had some difficulty coming up with a good name for the file
that gets included in all of the exercise READMEs for a given track.

These are global hints, like how to run the test suite, which are
relevant to all the exercises on a track.

We started with SETUP.md in the root of the repository, then renamed
that to exercises/TRACK_HINTS.md because SETUP.md was misleading and
confusing, but then we realized that TRACK_HINTS.md was a bit ambiguous
and confusing as well.

Finally we settled on putting the file in the docs directory, since
this is user-facing documentation, and calling the file
EXERCISE_README_INSERT.md

See https://github.com/exercism/meta/issues/5 for context.
 2017-06-09 11:12:49 -06:00
Rootul Patel
6c962f9434 Update Installation with supported Python versions (#437) 
* Update Installation with supported Python versions
* Remove Packages
 2017-03-26 22:17:13 +02:00
Rootul Patel
9a89896ff3 Update image paths (#436) 2017-03-20 13:23:42 +01:00
Tammo Behrends
1e1f5c86e2 Add PyCharm EDU as resource 
closes #394
 2017-03-16 13:52:40 +01:00
Ilya Zonov
ef5beff640 Fix py.test run in documentation (#334) 
Just add '\n' between `cd` and `py.test` commands
 2016-05-08 10:48:29 -06:00
Tammo Behrends
4e4f1e5b65 Corrects pip install command 
see #332
 2016-04-14 13:17:43 +02:00
Victor Goff
776e725630 Remove old help site links 
Closes #323

References exercism/todo#181
 2016-04-03 12:41:48 -06:00
Kartik Singhal
ffa11c6f2c Merge workflow document into testing 
Fixes #315
 2016-03-25 18:31:00 -04:00
Christopher Huang
f73a5131c8 Update TESTS.md 
Command line for pytest is `py.test`. Corrected some typos and grammar.
 2016-02-26 18:16:48 -08:00
Tammo Behrends
d3383e93f5 Merge pull request #293 from oalbe/master 
Created LEARNING.md and TESTS.md.
 2016-02-15 21:13:08 +01:00
Mark Mandel
835da7efab Correct iPython to IPython 2016-02-11 22:29:30 -06:00
Alberto
f5a152942c Create LEARNING.md and TESTS.md 2016-02-02 12:46:51 +01:00
Mark Mandel
fe09a72ff4 Wording changes in ABOUT.md 
Corrected typo for 'interactive' and reworded introductory sentences to include input from @kytrinyx about resources available for Python, from https://github.com/exercism/xpython/pull/275.
 2016-01-02 00:59:11 -06:00
Mark Mandel
65845bb56d Create ABOUT.md 2015-12-06 23:03:35 -06:00