https://open-source-silicon.dev logo
Join Slack
Powered by
Getting this message but my documentation is all o...
# shuttle-precheck
r
Getting this message but my documentation is all objective
t
@User: Is there documentation somewhere that states under what conditions the "Project documentation is not appropriate" is flagged during precheck?
r
Copy code
Documentation:
Documentation file README.md exists and does not use any non-inclusive language
m
@User Does your README.md use the word 'slave'? If it does, you could change it to 'follower'.
From 
mpw_precheck/checks/documentation_check.py
Copy code
BANNED_WORDS = ['blacklist', 'slave', 'whitelist']  # Banned Keywords
May also be viewable in the 
PRECHECK_LOCAL_d/logs/precheck.log
r
STDOUT: DOCUMENTATION FILE UNICODE DECODE EXCEPTION in (baseband_inductorless_automatic_gain_control/._README.md): 'utf-8' codec can't decode byte 0xb0 in position 37: invalid start byte
Pretty sure position 37 was an opening parentheses 
(
Not sure why this would error out
t
Can you post that README file?
Python's text decoding is a huge mess. I've run into issues with it many times.
r
Ive removed some of the parentheses and text from below images, as my first guess was I said something non-inclusive
Running the precheck again
t
The error message, though, was that it saw a non-ASCII code 0xb0 in what was supposed to be a text file. Possibly there is (was) an inadvertent ISO character in the text.
r
Running it locally gives no error
Open in Slack
PreviousNext
Powered by