search

jrxFive / python-nomad

Client library Hashicorp Nomad
https://python-nomad.readthedocs.io/en/latest/
MIT License
139 stars 73 forks source link

No documentation on `.address` in class Nomad #129

Open wimax-grapl opened 2 years ago

wimax-grapl commented 2 years ago

https://github.com/jrxFive/python-nomad/blob/master/nomad/__init__.py

One has to drill down to the Requester object to learn that address takes precedence over host/port. https://github.com/jrxFive/python-nomad/blob/f6dcba8176ded3fdcd5a76d9ded8cab3d3091c02/nomad/api/base.py#L53 if anything, this should be some sort of xor (throw an exception if address and [host/port] are specified)

jonathanrcross commented 2 years ago

Hey @wimax-grapl, sorry for getting burned by that... We'll certainly add to the docstring and possible add a warning about have both parameters set, don't want to introduce a break change.

wimax-grapl commented 2 years ago

Makes sense, thanks!

On Tue, Dec 7, 2021, 4:01 PM jonathanrcross @.***> wrote:

Hey @wimax-grapl https://github.com/wimax-grapl, sorry for getting burned by that... We'll certainly add to the docstring and possible add a warning about have both parameters set, don't want to introduce a break change.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/jrxFive/python-nomad/issues/129#issuecomment-988260386, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQOPO7MNCERMYOK2TB2INX3UPZYZ3ANCNFSM5JPAFC7Q . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.