Skip to content
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.

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

refactor: clarify naming of user-facing options #184

Merged
merged 1 commit into from
Nov 8, 2023
Merged

Conversation

CBenoit
Copy link
Member

@CBenoit CBenoit commented Nov 8, 2023

  • When appropriate, "hostname" was renamed into "client_computer_name"

  • Likewise, "Kerberos::url" has been renamed to "Kerberos::kdc_url" and the meaning of the field has been documented (KDC url vs KKDCP url)

  • A wrapper around username is exposed to the library user to make it clear that there are different formats:

    • User Principal Name (UPN)
    • Down-Level Logon Name

    Convenience functions are provided to help the user building
    proper usernames.

@CBenoit CBenoit requested a review from a team November 8, 2023 01:33
@CBenoit CBenoit force-pushed the clarify-naming branch 2 times, most recently from be59d7f to d1c685f Compare November 8, 2023 01:36
@CBenoit CBenoit force-pushed the clarify-naming branch 3 times, most recently from 8097534 to 7a28e36 Compare November 8, 2023 23:29
@CBenoit CBenoit enabled auto-merge (squash) November 8, 2023 23:30
- When appropriate, "hostname" was renamed into "client_computer_name"

- Likewise, "Kerberos::url" has been renamed to "Kerberos::kdc_url" and
  the meaning of the field has been documented (KDC url vs KKDCP url)

- A wrapper around username is exposed to the library user to make it
  clear that there are different formats:

  - User Principal Name (UPN)
  - Down-Level Logon Name

  Convenience functions are provided to help the user building
  proper usernames.
@CBenoit CBenoit merged commit 6549a7f into master Nov 8, 2023
40 checks passed
@CBenoit CBenoit deleted the clarify-naming branch November 8, 2023 23:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants