search

fieldOfView / OctoPrint-ngrok

An OctoPrint Plugin that provides remote access using ngrok
GNU Affero General Public License v3.0
15 stars 8 forks source link

Update __init__.py #21

Closed theely closed 3 years ago

theely commented 3 years ago

Rename event payload dictionary key from tunnel to tunnel_url

fieldOfView commented 3 years ago

Could you elaborate on why this is necessary? I would prefer not to change this around, because it would be a breaking chnge for those already using the event.

theely commented 3 years ago

It's not required.

However 'tunnel' is an ambiguous term that do not properly describes the value associated with it. Since it's a braking change you might want to consider this before it's too late. Adoption should be limited now.

Keeping the exiting term 'tunnel' might causes problems for future expansion of the dictionary since it's such a lose and generic term in this context.

On Fri, 18 Sep 2020, 21:54 Aldo Hoeben, notifications@github.com wrote:

Could you elaborate on why this is necessary? I would prefer not to change this around, because it would be a breaking chnge for those already using the event.

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/fieldOfView/OctoPrint-ngrok/pull/21#issuecomment-695056174, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAPOUD2XSVUYMQMBBO4ZMHLSGO3FZANCNFSM4RSLXC7Q .

fieldOfView commented 3 years ago

Keeping the exiting term 'tunnel' might causes problems for future expansion of the dictionary

After long deliberation, I have decided to cross that bridge when we come to it.