inkle/ink

Don't throw exception from ContentAtPath

Open

#211 opened on Oct 16, 2016

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (466 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (3,743 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Container's ContentAtPath currently throws an exception if it fails, which creates some rather ugly try/catch code in a number of places where we want to be able to fail gracefully if the content can't be found.

Convert ContentAtPath to return null if it doesn't find the content, and throw exceptions at the call site where it's still intended. (Such as in the main Step() function).

Note that this should be relatively straightforward if anyone wants to give it a try! (Though not before #210 is fixed so you can verify your code!)

Contributor guide

Research direction
Find all uses of ContentAtPath, modify it to return null instead of throwing, and update call sites that rely on exceptions.
Tech stack
csharp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85