Skip to content

Fix docs to changed signature of getYBoundary - #3469

Open
dschwoerer wants to merge 1 commit into
nextfrom
IsSheathAPI
Open

Fix docs to changed signature of getYBoundary#3469
dschwoerer wants to merge 1 commit into
nextfrom
IsSheathAPI

Conversation

@dschwoerer

Copy link
Copy Markdown
Contributor

getYBoundary is a free function and takes the coordinates as an argument.

@ZedThree

Copy link
Copy Markdown
Member

I'm not sure I understand why it is a free function? It accesses private members of Coordinates and is declared a friend -- why not just make it a member?

@dschwoerer

Copy link
Copy Markdown
Contributor Author

I do not remember why I did change it. But I think the docs should match the API at least ...

One advantage of a free function: It can be inlined, but that is probably not sufficient motivation to make it a free function, but maybe enough to keep it as is?

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 this pull request may close these issues.

2 participants