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

[FEAT]: Remove all Django documentation in the project #1078

Open
AbhijithGanesh opened this issue Oct 2, 2021 · 8 comments
Open

[FEAT]: Remove all Django documentation in the project #1078

AbhijithGanesh opened this issue Oct 2, 2021 · 8 comments
Labels
triage Issues that have not been categorized or prioritized

Comments

@AbhijithGanesh
Copy link
Collaborator

Description

There are documentation strings related to the project when it was created and it is better if we remove it since we've migrated from the original version

What should have happened?

No response

What browser(s) are you seeing the problem on?

No response

Further details

No response

@AbhijithGanesh AbhijithGanesh added the triage Issues that have not been categorized or prioritized label Oct 2, 2021
@brylie
Copy link
Member

brylie commented Oct 2, 2021

@AbhijithGanesh can you point to an example documentation string?

@AbhijithGanesh
Copy link
Collaborator Author

AbhijithGanesh commented Oct 2, 2021

'''
WSGI config for civiwiki project.

It exposes the WSGI callable as a module-level variable named ``application``.

For more information on this file, see
https://docs.djangoproject.com/en/1.8/howto/deployment/wsgi/
'''

Code bits like this(it is meant for django 1.8 but we use 3.2)

@brylie
Copy link
Member

brylie commented Oct 2, 2021

If you want, you can update the comments with more recent links. However, I don't think we should remove them.

@AbhijithGanesh
Copy link
Collaborator Author

They're not relevant anymore right? I can update them as a part of documentation process! Would that be fine? I will add docstrings for this project and remove the Django 1.8 related strings? @brylie

@brylie
Copy link
Member

brylie commented Oct 2, 2021

They're not relevant anymore right?

One thing worth noting is that Django code and conventions tend to stay relevant for many years. It might be good for us to revisit some of these older files to identify where the conventions have changed/improved, but that may be out of scope for this task.

I will add docstrings for this project and remove the Django 1.8 related strings?

Just change any links containing djangoproject.com to the latest version.

@AbhijithGanesh
Copy link
Collaborator Author

They're not relevant anymore right?

One thing worth noting is that Django code and conventions tend to stay relevant for many years. It might be good for us to revisit some of these older files to identify where the conventions have changed/improved, but that may be out of scope for this task.

I will add docstrings for this project and remove the Django 1.8 related strings?

Just change any links containing djangoproject.com to the latest version.

Will keep them on my mind.

@brylie

This comment has been minimized.

@AbhijithGanesh

This comment has been minimized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Issues that have not been categorized or prioritized
Projects
None yet
Development

No branches or pull requests

2 participants