Skip to content

[MSHARED-1273] clean up API doc and exceptions - #158

Merged
elharo merged 1 commit into
masterfrom
MSHARED-1271
Jun 19, 2023
Merged

elharo merged 1 commit into
masterfrom
MSHARED-1271

Conversation

@elharo

@elharo elharo commented Jun 18, 2023

Copy link
Copy Markdown
Contributor

still trying to figure out how best to replace these methods completely

@elharo
elharo requested review from gnodet and slachiewicz June 18, 2023 19:54
@slawekjaranowski

Copy link
Copy Markdown
Member

Maybe commit message should contain ... and do not throw IOException as jira issue
we don't add exceptions

@slachiewicz

Copy link
Copy Markdown
Member

so it will be breaking change

@elharo

elharo commented Jun 19, 2023 •

Copy link
Copy Markdown
Contributor Author

It isn't throwing IOException now. This PR brings the throws clauses in sync with what the code was already (not) doing. I was a little surprised this wasn't already a compiler error. There's something I'm not quite seeing here.

@elharo
elharo merged commit d783201 into master Jun 19, 2023
@elharo
elharo deleted the MSHARED-1271 branch June 19, 2023 11:13
@slachiewicz

Copy link
Copy Markdown
Member

external code that use this methods and catch exception will be broken after update

@elharo

elharo commented Jun 19, 2023

Copy link
Copy Markdown
Contributor Author

You're right. I think I was mixing up catch blocks for unthrown exceptions and throws clauses for unthrown exceptions in my head. I'll send another PR to clean this up.

@slachiewicz

Copy link
Copy Markdown
Member

No problem. You just have to release minor versions and not bugfix

@jira-importer

Copy link
Copy Markdown

Resolve #330

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants