Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Use ".. code:: language" syntax for code blocks in rst files

Open Beginner friendly
  • Is something wrong?
#767 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by comparing code blocks in the reStructuredText documentation with the code:: c examples in doc/guide/plugin.rst. Find blocks marked with :: and check which language each contains. Done means those blocks use .. code:: language syntax and show syntax highlighting in VSCode and GitHub.

Written by the indexing model from the issue text.

Description

Within VSCode and github, code blocks in rst files marked with :: do not show any syntax highlighting. This is true even when .. highlight:: python is included at the top of the .rst file (tested in VSCode, not in github).

Using .. code:: language for code blocks provides syntax highlighting work in both VSCode and in github. See for example the code:: c blocks in plugin.rst.

Dominant language
Python
Stars
23
Forks
32
Avg merge
7d 20h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from SasView/sasmodels

All issues in SasView/sasmodels

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.