[New Concept Documents] : comparisons concept

[BethanyG]

This issue describes how to implement the comparisons concept documents for the python track.

Getting started

Please please please read the docs before starting. Posting PRs without reading these docs will be a lot more frustrating for you during the review cycle, and exhaust Exercism's maintainers' time. So, before diving into the implementation, please read up on the following documents:

• Contributing to Exercism | Help
• What are those Weird Task Tags about?
• Building Language Tracks: An Overview
• What are Concepts?
• Concept Exercise Specifications
• Exercism Formatting and Style Guide
• Exercism Markdown Specification

Concept Description

Please see the following for more details on concepts & concept exercises.

Topics under this concept:

• Comparison priority in Python
• Comparison operators ==, >, <, !=
• Identity methods is and is not
• Equality applied to built-in types
• Equivalence vs equality
• Inequality

Resources to get started writing:

• Comparisons in Python (Python language reference)
• Value comparisons in Python (Python language reference)
• Identity comparisons in Python (Python language reference)
• Python operators official doc
• Numeric types (Python Docs)
• Decimal types (Python Docs)
• Fractions (Python Docs)
• Sequence types (Python Docs)
• Python Object Model (Python docs)
• Basic Customization
• Python basic operators on tutorialspoint
• Python comparison operators on data-flair
• PEP 207 to allow Operator Overloading for Comparison

introduction.md

Spec detail can be found here: concept introduction.md

This can also be a summary/paraphrase of the about.md file, and will provide a brief introduction of the concept for a student who has not yet completed the concept exercise. It should contain a good summation of the concept, but not go into lots of detail/discussion. Here is a partial screengrab of the page where introduction.md displays:

about.md

Spec detail can be found here: concept about.md

This file provides information about this concept for a student who has completed the corresponding concept exercise. It is intended as a reference/ jumping off point for continued learning, and may go into detail about performance, variation, or other interesting details. Here is a partial screengrab of the page where about.md displays:

links.json

Spec detail can be found here: concept links.json

This file provides links to information and resources about the concept, including official documentation, tutorials, blog posts, essays, etc. These links show at the bottom of the concept page:

• We strongly prefer OSS/free resources and those that do not require an account/signup. Please do not link to resources that are paid.
• The same resources listed in this issue can be used, but they're just a starting point. Feel free to add/amend/edit them.
• If there are particularly good/interesting information sources for this concept that extend it or discuss alternative/interesting applications, -- please feel free to add them. These are intended to help the student explore the concept in more detail, so they can include topics that are related or tangental to the concept.

Concept Metadata Files Under .meta/config.json

For more information on concept .meta/ files and formatting, see concept metadata files

blurb --- We recommend starting with the first paragraph of either the concepts introduction.md or about.md files, and editing it down to the <= 350 character limit. Here are screengrabs of a blurb (in this case basics and strings) in a couple different contexts:

On the Concepts "journey" page:

On the Exercise Details Page, under the "unlocked" section:

Implementation Notes

• We use AmEn (American English), and write in a semi-formal (not completely conversational, but not academic either). Like explaining something to your class at school, or your colleagues at work.
• Code examples should follow the same format as the Python Docs. Here's a short example:

• Our markdown and JSON files are checked against prettier . We recommend setting prettier up locally and running it prior to submitting your PR to avoid any CI errors.

Getting Help

If you have any questions while implementing the exercise, please post the questions as comments in this issue, or contact one of the maintainers on our Slack channel. _We're happy to help!

[BethanyG]

PLEASE NOTE: PR592 is the implementation of the associated concept exercise. However, that exercise cannot "go live" without this associated concept write-up.

Please review the documents for the associated concept exercise as well as its design document to make sure this write-up is of similar tone and subject.