carpentries-incubator / carpentries-incubator/python-intermediate-inflammation

Bug in diagrams

Open
#62 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
8
Forks
443
PR merge metrics
No merged PRs in 30d

Description

This type of error is present in multiple diagrams, where the accessible title is not being set correctly.
The following is an example of a diagram with the error in the setting the scene section:
```
Please enter an accessible title using 'accTitle'.
Diagram source code
flowchart LR
accTitle: Overview of sections in the lesson
accDescr {Course overview diagram. Arrows connect the following boxed
text in order: 1) Setting up software environment 2) Verifying software
correctness 3) Software development as a process 4) Collaborative
development for reuse 5) Managing software over its lifetime.}
A(1. Setting up software environment) --> B(2. Verifying software correctness)
B --> C(3. Software development as a process)
C --> D(4. Collaborative development for reuse)
D --> E(5. Managing software over its lifetime)
```
Section 1: Setting Up Environment For Collaborative Code Development has the same error:
```
accDescr {Topics on effective collaborating on code development covered in the current section: virtual development environments, version control & sharing code, writing readable code & code standards}
```
The git diagram too:
```
accDescr {Basic development lifecycle with Git and commands for moving files between the Git infrastructure: working tree, staging area, local repository, and remote repository.}
```
The one about correctness:
```
accDescr {Topics on verifying software correctness covered in the current section: testing frameworks, automating and scaling up testing, and code debugging}
```
Also Software Development as a Process
```
accDescr {Topics on software engineering process covered in the current section: gathering requirements, software architecture & design, programming paradigms}
```
And Collaborative Software Development for Reuse
```
accDescr {Topics on collaborative software development covered in the current section: code review, writing software documentation, packaging & releasing software}
```
and Code Reviews via GitHub’s Pull Requests
```
accDescr {Code review process: a developer submits code, reviewer provides feedback and requests changes, revisions are made, and the code is approved and merged}
```
and Managing and Improving Software Over Its Lifetime
```
accDescr {Flow chart showing five stages in software management lifecycle: 1. Setting up software environment; 2. Verifying software correctness; 3. Software development as a process; 4. Collaborative development for reuse; 5. Managing software over its lifetime - issue reporting & prioritisation, Agile development in sprints, software project management.}
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the diagrams listed in the issue across the lesson content and inspect their accessible-title and description declarations. Check how the diagrams render and compare them with the example showing the reported error. Done means each listed diagram has a correctly recognized accessible title and continues to render with its description.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.