For lack of a better name, the wrapper will be called
ScrapyCloudEx. As you can see in the linked documentation above, the API endpoints are split across 2 areas: “app” and “storage”. These change the API calls to some degree (e.g. pagination options are different in app and storage).
I wanted my wrapper to closely follow the API documentation (so it’s easier for the user to know which function maps to which API endpoint), and each endpoint wrapper is therefore implemented in its own module such as
My issue is that this is a very long and cumbersome name. When coding this isn’t an issue (using e.g.
alias among other options), but it becomes a problem when viewing the documentation generated by ExDoc: the module names in the sidebar get clipped because they are too long.
What’s the best way to address this? Is there a way to provide some sort of “alias” for the value displayed in the sidebar? Should I create a new module with a shorter name that just
defdelegates to the actual implementation (e.g.
defdelegateing all public functions to
ScrapyCloudEx.Endpoints.Storage.Items)? Some other approach?