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

Error in documentation? #109

Closed
Nekidev opened this issue May 9, 2023 · 1 comment · Fixed by #113
Closed

Error in documentation? #109

Nekidev opened this issue May 9, 2023 · 1 comment · Fixed by #113
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Nekidev
Copy link
Contributor

Nekidev commented May 9, 2023

The readme says that the default settings are the following:

PICTURES = {
    "BREAKPOINTS": {
        "xs": 576,
        "s": 768,
        "m": 992,
        "l": 1200,
        "xl": 1400,
    },
    "GRID_COLUMNS": 12,
    "CONTAINER_WIDTH": 1200,
    "FILE_TYPES": ["WEBP"],
    "PIXEL_DENSITIES": [1, 2],
}

But if you run a Django project without adding the placeholder URLs an error is raised. Shouldn't it then be

PICTURES = {
    "BREAKPOINTS": {
        "xs": 576,
        "s": 768,
        "m": 992,
        "l": 1200,
        "xl": 1400,
    },
    "GRID_COLUMNS": 12,
    "CONTAINER_WIDTH": 1200,
    "FILE_TYPES": ["WEBP"],
    "PIXEL_DENSITIES": [1, 2],
    "USE_PLACEHOLDERS": True
}

?

@codingjoe
Copy link
Owner

Hi @Nekidev,

Yes, that is an excellent observation. Would you care to provide a small pull-request to fix the documentation? I feel you deserve the credit here :)

Cheers!
Joe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants