Skip to content

Conversation

@p-r-a-v-i-n
Copy link
Contributor

According to DRF language-style the documentation should follow the american english style.

But I have found some British style words or inconsistent spellings like behaviour, customise, initialise, e-mail, Sub-classes in the docs. In this PR I have modified them to DRF style.

I have touched 26 files. and I can understand this is relatively large change. I'm not sure whether DRF team will like my approach or not. but if anything is there I'm happy to adjust.

Note: highlight.pack.js were intentionally not modified.

Copy link
Collaborator

@browniebroke browniebroke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we configure codespell in any way to catch this in the future? We're already using it as pre-commit hook

self.endpoints = None

def _initialise_endpoints(self):
def _initialize_endpoints(self):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unlike the others which are in documentation, this is an actual code change. Even if it's a private method, I'm not sure it's worth changing this...

If we do change it, I'd rather make it a separate change, to avoid us missing it while doing the release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants