Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NmeaLineParser should include argument name in ArgumentException #152

Open
idg10 opened this issue Mar 28, 2022 · 4 comments · May be fixed by #153
Open

NmeaLineParser should include argument name in ArgumentException #152

idg10 opened this issue Mar 28, 2022 · 4 comments · May be fixed by #153

Comments

@idg10
Copy link
Contributor

idg10 commented Mar 28, 2022

Also, the docs should state that the NmeaLineParser ctos throws an ArgumentException to report the discovery of bad data.

@fredeil
Copy link

fredeil commented Apr 5, 2022

Hey @idg10 , we're using this library (at @Dualog) and wanted to contribute back.

Could you clarify if you would like to have all of the ArgumentException s to reference the line input parameter? It's the only argument for the method but some of the argumentExceptions are being thrown on a subset of that line

See fredeil@2655552

@idg10
Copy link
Contributor Author

idg10 commented Apr 6, 2022

Yes, I just meant that the relevant throws should use nameof(line) as the paramName argument when constructing the ArgumentException. (So exactly what you've done in that commit.)

Thanks for offering to do this. While you're in there would you mind adding an <exception> tag to the relevant XML doc comments, so it's clear to anyone using this library that this is how we report unparseable data?

@fredeil
Copy link

fredeil commented Apr 6, 2022

Sure, that was my next question.

No more documentation needed outside of that? @idg10

@idg10
Copy link
Contributor Author

idg10 commented Apr 6, 2022

Nothing I'm aware of, but if you feel it's missing something feel free either to add more, or to open another issue describing what's missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants