search

byuccl / RapidSmith2

RapidSmith2 - the Vivado successor to RapidSmith. Released Jan 4, 2017.
Other
41 stars 13 forks source link

reverseRouting naming inconsistency #343

Open DallonTG opened 6 years ago

DallonTG commented 6 years ago

PR #340 renamed reverseWireConnections in SiteTemplate to reverseRouting. Some public methods, including setReverseWireConnections, were also renamed. The original methods no longer exist at all, breaking code that used these methods. The version of RS2 was incremented with this PR however.

The name reverseWireConnections is still used in the code in other places though, like Tile.java. The same is true for wireConnections, which has been renamed to routing in some places. It seems inconsistent and confusing for these names to be not be the same everywhere in the code. We should make the names of these data structures consistent throughout the code.

trharoldsen commented 6 years ago

I've never considered the device building methods to be part of the public API. The methods are only public due to the limitations of Java.

On Sat, Mar 3, 2018 at 3:45 PM, Dallon notifications@github.com wrote:

PR #340 https://github.com/byuccl/RapidSmith2/pull/340 renamed reverseWireConnections in SiteTemplate to reverseRouting. Some public methods, including setReverseWireConnections, were also renamed. The original methods no longer exist at all, breaking code that used these methods. The version of RS2 was incremented with this PR however.

The name reverseWireConnections is still used in the code in other places though, like Tile.java. The same is true for wireConnections, which has been renamed to routing in some places. It seems inconsistent and confusing for these names to be not be the same everywhere in the code. We should make the names of these data structures consistent throughout the code.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/byuccl/RapidSmith2/issues/343, or mute the thread https://github.com/notifications/unsubscribe-auth/AMdCwvj6lYtzqs99Ysd9mA3IhsYa7HP0ks5tawDTgaJpZM4SbEwN .

DallonTG commented 6 years ago

I suppose that's true - most people will never be using the device building methods.

It still might be nice to make the names more consistent throughout RS2, but I'd say that's low priority.