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.

Sign up for GitHub

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

Jump to bottom

Use of a slang expressions should be avoided in readthedocs #887

Closed
DennisClark opened this issue Aug 29, 2022 · 2 comments
Closed

Use of a slang expressions should be avoided in readthedocs #887

DennisClark opened this issue Aug 29, 2022 · 2 comments
Assignees
@johnmhoran
Labels
documentation Everything about documentation

Comments

@DennisClark
Copy link
Member

DennisClark commented Aug 29, 2022 •
edited
Loading

The unexpected term “sausage” can be found at
https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_new_importer.html
and we should avoid terms that could be mis-interpreted

A lot of internal sausage about importers could be found inside

There is a similar problem at
https://vulnerablecode.readthedocs.io/en/latest/tutorial_add_new_improver.html

perhaps discussion would be a better word here than sausage.
@DennisClark DennisClark added the documentation Everything about documentation label Aug 29, 2022
@johnmhoran
Copy link
Member

Done.

johnmhoran added a commit that referenced this issue Aug 30, 2022
@johnmhoran
Implement initial set of RTD updates #885 #886 #887 #888
d0dd5b3 
Reference: #885
Reference: #886
Reference: #887
Reference: #888

Signed-off-by: John M. Horan <[email protected]>
@johnmhoran johnmhoran mentioned this issue Aug 30, 2022
Merged
johnmhoran added a commit that referenced this issue Sep 2, 2022
@johnmhoran
Merge pull request #890 from nexB/update-rtd
9f89bca 
Implement initial set of RTD updates #885 #886 #887 #888
@johnmhoran
Copy link
Member

Done and closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@johnmhoran johnmhoran

Labels
documentation Everything about documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@DennisClark @johnmhoran