Few issues regarding the documentation

Aberta
  • Algo errado?
#182 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
45/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Start with doc/source/glossary.rst, then check the CORS and bucket lifecycle mentions at doc/source/tutorial.rst line 102 and b2sdk/api.py lines 194-195. Fix the dead sync.html link in doc/source/quick_start.rst line 77, then review the toctree in doc/source/api_reference.rst lines 44-66 and the REALM_URLS docstring in b2sdk/account_info/abstract.py lines 33-37. Done when each listed item is addressed or explicitly declined by a maintainer, since the thread has no replies.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

enhancement good first issue

Few remarks regarding the documentation were put into the git repository under:

  • doc/source/missing.txt
  • doc/source/remarks.txt

These files were removed in #178 and all issues from there are moved here.

doc/source/missing.txt:

Missing	

1. Missing explanation	
In 	
doc/source/tutorial.rst 	
    line 102 	
AND in 	
b2sdk/api.py 	
    line 194 	
there are mentions of "CORS rules" which are not explained anywhere.	
Nothing in doc/source/glossary.rst either. 	
Proposed fix: add to glossary, if possible, add to on-hover	

2. Missing explanation	
In 	
doc/source/tutorial.rst 	
    line 102	
AND in 	
b2sdk/api.py 	
    line 195	
there are mentions of "bucket lifecycle rules" which are not explained anywhere.	
Nothing in doc/source/glossary.rst either.	
Proposed fix: add to glossary, if possible, add to on-hover	

3. Dead link	
doc/source/quick_start.rst	
    line 77:	
"""	
    To learn more about sync, see `Sync <sync.html>`_.	
"""

doc/source/remarks.txt:

4.	
I cannot find these in code, but some of the elements of .. toctree:: in doc\source\api_reference.rst - lines 44-66 - do not have any titles (the fact that some of the others have them non-descriptive or non-helpful is another matter entirely).	
    api/internal/utils                      - b2sdk.utils	
    api/internal/cache                      - b2sdk.cache	
    api/internal/sync/action                - b2sdk.sync.action	
    api/internal/sync/exception             - b2sdk.sync.exception	
    api/internal/sync/file                  - b2sdk.sync.file	
    api/internal/sync/folder                - b2sdk.sync.folder	
    api/internal/sync/folder_parser         - b2sdk.sync.folder_parser	
    api/internal/sync/policy                - b2sdk.sync.policy	
    api/internal/sync/policy_manager        - b2sdk.sync.policy_manager	
    api/internal/sync/scan_policies         - b2sdk.sync.scan_policies	
    api/internal/sync/sync                  - b2sdk.sync.sync	
    api/internal/transferer/file_metadata   - b2sdk.transferer.file_metadata	
    api/internal/upload_source              - b2sdk.upload_source	


5.	
Dicts get squashed and much less convenient to read/copy from. E.g.:	
b2sdk\account_info\abstract.py, lines 33-37:	
"""	
    REALM_URLS = {	
        'production': 'https://api.backblazeb2.com',	
        'dev': 'http://api.backblazeb2.xyz:8180',	
        'staging': 'https://api.backblaze.net',	
    }	
"""	

while in the docs it looks like this:	
"""	
REALM_URLS = {'dev': 'http://api.backblazeb2.xyz:8180', 'production': 'https://api.backblazeb2.com', 'staging':	
'https://api.backblaze.net'}	
"""
Linguagem predominante
Python
Estrelas
214
Forks
68
Merge médio
51min
PRs com merge (30d)
6

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Backblaze/b2-sdk-python

Todas as issues de Backblaze/b2-sdk-python

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.