DOC: exemplo incorreto no README (incorrect example on README)

[aureliobarbosa]

O exemplo de construção de um objeto Notifiable no README está inconsistente com a intenção: ao invés de criar uma notifição para nomes com menos de três letras, ele cria notificações para nomes MAIORES do que três letras. O exemplo abaixo:

class Nome(Notifiable):
    def __init__(self, nome):
        super().__init__()

        if len(nome) > 3:
            self.add_notification(field='nome', message='nome inválido')
        self._nome = nome

Deveria ser:

class Nome(Notifiable):
    def __init__(self, nome):
        super().__init__()

        if len(nome) < 3:
            self.add_notification(field='nome', message='nome inválido')
        self._nome = nome

Esta é um bom exercício para alguém que está começando a programar em python.

• Versão do PyFlunt: 2.3

[aureliobarbosa]

Thanks @ChinoUkeagbu,

This issue came by when we were discussing this library during Python Brasil 2024 and the idea was to use it as an example to teach someone to do the first PR.

Fixing the doc is trivial but demands knowledge about git and github... Nevertheless... What I found amazing was the speed it took we got this issue 'solved' by simply marking it as "good first issue". Thank you!

Look this @fazedordecodigo. The issue didn't survive two days!

[ChinoUkaegbu]

No worries haha I'll close the PR! Yeah there's a couple of sites that collate good first issues from different repositories together to make it easier for people new to open source, that's how I found this one actually.