Working with the Code Base

• Code Formatting
  • Type Hinting
• Docstrings
• reST Quick Start
  • Creating Links
• Deprecations
  • Adding a Deprecation
    • Removing a Public API
    • Changing a Default
  • Removing a Deprecation
    • Removing a Public API
    • Changing a Default
• Testing
  • Test Categories
    • Unit Tests
    • Integration Tests
  • Testing tools
    • Custom assertions
    • Context managers
    • Patching
    • Graphic tests
  • Adding or Updating Graphics Tests
    • Generating New Results
    • Reviewing Failing Tests
    • Adding a New Image Test
    • Refreshing the Stored Hashes
    • Add Your Changes to Iris
  • Running the Tests
    • Testing Iris in a Manually Created Environment
    • Using Nox for Testing Iris
  • Continuous Integration (CI) Testing
    • GitHub Actions
    • SciTools CLA Checker
    • pre-commit CI
  • Benchmarking
    • Continuous Integration
    • Other Uses

previous

Contributing to the Documentation

next

Code Formatting