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

Few issues regarding the documentation #182

Open
mlech-reef opened this issue Jan 19, 2021 · 0 comments
Open

Few issues regarding the documentation #182

mlech-reef opened this issue Jan 19, 2021 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mlech-reef
Copy link
Contributor

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'}	
"""
@mlech-reef mlech-reef added the good first issue Good for newcomers label Jan 19, 2021
@mjurbanski-reef mjurbanski-reef added the enhancement New feature or request label Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants