Skip to content
Snippets Groups Projects
  • Paul Melnikow's avatar
    02ec19fd
    BaseService terminology: Rename `url` to `route` (#2278) · 02ec19fd
    Paul Melnikow authored
    The term “url” is overloaded in services, to refer to the Shields route and also the API URL. Calling the Shields URL a “route” is on the whole more descriptive, and makes it clearer and more obvious which one of these we’re talking about. It’s a small thing, though seems like an improvement.
    
    We have a few functions called `buildUrl`. I’ve renamed them to `buildRoute` when they refer to routes, and left them as `buildUrl` when they refer to API URLs.
    
    I included a minor style tweak and some formatting cleanup in `TUTORIAL.md`.
    02ec19fd
    History
    BaseService terminology: Rename `url` to `route` (#2278)
    Paul Melnikow authored
    The term “url” is overloaded in services, to refer to the Shields route and also the API URL. Calling the Shields URL a “route” is on the whole more descriptive, and makes it clearer and more obvious which one of these we’re talking about. It’s a small thing, though seems like an improvement.
    
    We have a few functions called `buildUrl`. I’ve renamed them to `buildRoute` when they refer to routes, and left them as `buildUrl` when they refer to API URLs.
    
    I included a minor style tweak and some formatting cleanup in `TUTORIAL.md`.