Skip to content

removal of potentially harmful parameter. #91

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.

Sign up for GitHub

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

Merged
davecom merged 7 commits into from
Apr 1, 2025
Merged

removal of potentially harmful parameter. #91

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
90fe758
removal of potentially harmful parameter.
KneupnerTrackunit Jan 7, 2025
ce4996e
making it a non-breaking change
KneupnerTrackunit Jan 8, 2025
941dea6
small improvement, taking default value out.
KneupnerTrackunit Jan 8, 2025
ad7a2eb
Update Sources/SwiftGraph/Graph.swift
Vithanco Jan 8, 2025
43cca35
formatting only
KneupnerTrackunit Jan 9, 2025
49dcb08
Merge branch 'master' of vithanco:Vithanco/SwiftGraph
KneupnerTrackunit Jan 9, 2025
970a0b8
removing not needed import
KneupnerTrackunit Mar 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Sources/SwiftGraph/Graph.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,11 @@ extension Graph {
public var edgeCount: Int {
return edges.joined().count
}

@available(*, deprecated, renamed: "addEdge", message: "Use the addEdge method without the additional directed parameter instead, as the Edge contains already the information about direction. A double specification can only result in inconsistencies and errors.")
func addEdge(_ e: E, directed: Bool = false){
Copy link
Contributor

@ZevEisenberg ZevEisenberg Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
func addEdge(_ e: E, directed: Bool = false){
func addEdge(_ e: E, directed: Bool = false) {

Copy link
Contributor Author

@Vithanco Vithanco Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, you found an outdated version. I removed the default value (false) in the latest version.

Copy link
Contributor Author

@Vithanco Vithanco Jan 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without the default value there is a more clear distinction between the one-parameter version and the 2-parameter. And there is no confusion that you use the one-parameter version when you leave out the default parameter - and not using the default value

Copy link
Contributor Author

@Vithanco Vithanco Jan 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

formatting updated.

addEdge(e)
}

/// Returns a list of all the edges, undirected edges are only appended once.
public func edgeList() -> [E] {
Expand Down