Bug in documentation for ModelSelect2TagWidget

[pawnhearts]

There is a bug in documentation for ModelSelect2TagWidget. It should be cleaned_values = list(pks) instead of cleaned_values = list(values)

[codingjoe]

Hi @pawnhearts,

Thank you for reaching out. Excellent documentation is key for an open-source project. I sincerely appreciate your contribution here. That being said, I am not 100% sure I know where that line is? I'd welcome you to open a PR that changes the lines in question. I will make sure to review it quickly and deploy a new documentation.

Thanks!
Joe

[pawnhearts]

For some reason I can't find that part of documentation in sources. (mayby docs are built from another branch? or readthedocs is owned by previous maintainer?). Here is the link https://django-select2.readthedocs.io/en/latest/django_select2.html#django_select2.forms.ModelSelect2TagWidget 4th line from bottom in the example. It should be cleaned_values = list(pks). Otherwise it creates 2 duplicate tags and then fails on optgroups functions.

I was very confused until realized logic in that example is wrong.

Thanks for nice project, it's very useful.

[codingjoe]

Hi @pawnhearts, the documentation is built form Python doc-strings:

django-select2/django_select2/forms.py

Lines 583 to 608 in 4770f06

	class ModelSelect2TagWidget(ModelSelect2Mixin, HeavySelect2TagWidget):
	"""
	Select2 model widget with tag support.
	This it not a simple drop in widget.
	It requires to implement you own :func:`.value_from_datadict`
	that adds missing tags to you QuerySet.
	Example::
	class MyModelSelect2TagWidget(ModelSelect2TagWidget):
	queryset = MyModel.objects.all()
	def value_from_datadict(self, data, files, name):
	'''Create objects for given non-pimary-key values. Return list of all primary keys.'''
	values = set(super().value_from_datadict(data, files, name))
	# This may only work for MyModel, if MyModel has title field.
	# You need to implement this method yourself, to ensure proper object creation.
	pks = self.queryset.filter(**{'pk__in': list(values)}).values_list('pk', flat=True)
	pks = set(map(str, pks))
	cleaned_values = list(values)
	for val in values - pks:
	cleaned_values.append(self.queryset.create(title=val).pk)
	return cleaned_values
	"""

[pawnhearts]

Oh ic tnx. Made a PR

[codingjoe]

Resolved in #177

Thanks, @pawnhearts, I really appreciate the help!