Difficulty reading code in the tutorial

Open
#452 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by reviewing the tutorial's code presentation at the site scale shown in the attached image, focusing on long stretches of code that are difficult to read. Done means the tutorial code remains readable when displayed at typical site widths and scaling.

Written by the indexing model from the issue text.

Description

documentation

Due to the way in which the code in the tutorial is formated and how the site scales it is often hard to read long stretches of code.

Image
Dominant language
C++
Stars
424
Forks
127
Avg merge
2d 22h
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

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 KhronosGroup/Vulkan-Tutorial

All issues in KhronosGroup/Vulkan-Tutorial

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.