Fix docstring that used `example` tag instead of `exception`

bchavez / Bogus

:card_index: A simple fake data generator for C#, F#, and VB.NET. Based on and ported from the famed faker.js.

Other

8.66k stars 495 forks source link

Fix docstring that used `example` tag instead of `exception` #415

Closed DanteDeRuwe closed 2 years ago

DanteDeRuwe commented 2 years ago

Probable typo.

This makes sure that hovering over the method in IDE's has the relevant display for these exceptions. With the example tag, not even the name of the exception that was going to throw was visible.