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

Removed hundreds of formatting warnings for nltk.org #2859

Merged
merged 3 commits into from Oct 19, 2021

Conversation

tomaarsen
Copy link
Member

@tomaarsen tomaarsen commented Oct 18, 2021

Hello!

Pull request overview

  • Removed ~510 Sphinx warnings and errors regarding docstring formatting.
  • Removed a formatting issue with the news titles on https://www.nltk.org/news

The warnings/errors

When generating the website (with sphinx-build -E ./web/ ./build), Sphinx reports well over 520 warnings and errors. Most of these involve some formatting issue in a method docstring. For those unaware, Sphinx by default expects the Sphinx docstring format, which is essentially reStructuredText. ReST can be very strict at times. There were many issues regarding unexpected indents and missing blank lines, which have all been resolved with this PR.

The full list can be seen by clicking on this.
[sic]\nltk\ccg\chart.py:docstring of nltk.ccg.chart.CCGChartParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\chunk\regexp.py:docstring of nltk.chunk.regexp.ChunkString.__init__:10: WARNING: Unexpected indentation.
[sic]\nltk\chunk\regexp.py:docstring of nltk.chunk.regexp.ChunkString.__init__:16: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\classify\senna.py:docstring of nltk.classify.senna:17: WARNING: Unexpected indentation.
[sic]\nltk\classify\senna.py:docstring of nltk.classify.senna:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\cluster\__init__.py:docstring of nltk.cluster:43: WARNING: Unexpected indentation.
[sic]\nltk\cluster\util.py:docstring of nltk.cluster.util.Dendrogram.show:3: WARNING: Unexpected indentation.
[sic]\nltk\cluster\util.py:docstring of nltk.cluster.util.Dendrogram.show:4: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\cluster\util.py:docstring of nltk.cluster.util.cosine_distance:1: WARNING: Undefined substitution referenced: "u||v".
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\cmudict.py:docstring of nltk.corpus.reader.cmudict.CMUDictCorpusReader.dict:2: WARNING: Field list ends without a blank line; unexpected unindent.      
[sic]\nltk\corpus\reader\cmudict.py:docstring of nltk.corpus.reader.cmudict.CMUDictCorpusReader.entries:2: WARNING: Field list ends without a blank line; unexpected unindent.   
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent. 
[sic]\nltk\corpus\reader\plaintext.py:docstring of nltk.corpus.reader.plaintext.EuroparlCorpusReader:6: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.doc:31: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.frame:36: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.frame_relations:2: WARNING: Field list ends without a blank line; unexpected unindent.  
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:75: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:76: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:82: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:84: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:85: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:85: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:86: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\knbc.py:docstring of nltk.corpus.reader.knbc.KNBCorpusReader:16: WARNING: Unexpected section title.

Usage example
-------------
[sic]\nltk\corpus\reader\wordlist.py:docstring of nltk.corpus.reader.wordlist.MWAPPDBCorpusReader:4: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.instances:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.lines:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.nouns:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.translations:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.translations:11: WARNING: Definition list ends without a blank line; unexpected 
unindent.
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.instances:2: WARNING: Field list ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.lines:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.verbs:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.spkrutteranceids:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.transcription_dict:2: WARNING: Field list ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.utteranceids:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.__init__:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.docs:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.tokenized:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.pprint:7: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.custom_lemmas:9: WARNING: Field list ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.ic:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_pos_and_offset:5: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:6: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:7: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:12: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:21: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:22: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader:1: WARNING: Unknown target name: "tag".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader:1: WARNING: Unknown target name: "word".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader.__init__:9: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.BracketParseCorpusReader.__init__:9: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\api.py:docstring of nltk.corpus.reader.api.CorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\bnc.py:docstring of nltk.corpus.reader.bnc.BNCCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.BracketParseCorpusReader.__init__:9: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader:1: WARNING: Unknown target name: "tag".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader:1: WARNING: Unknown target name: "word".
[sic]\nltk\corpus\reader\bracket_parse.py:docstring of nltk.corpus.reader.bracket_parse.AlpinoCorpusReader.__init__:9: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\chasen.py:docstring of nltk.corpus.reader.chasen.ChasenCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\childes.py:docstring of nltk.corpus.reader.childes.CHILDESCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\cmudict.py:docstring of nltk.corpus.reader.cmudict.CMUDictCorpusReader.entries:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\cmudict.py:docstring of nltk.corpus.reader.cmudict.CMUDictCorpusReader.dict:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\conll.py:docstring of nltk.corpus.reader.conll.ConllChunkCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\crubadan.py:docstring of nltk.corpus.reader.crubadan.CrubadanCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent. 
[sic]\nltk\corpus\reader\dependency.py:docstring of nltk.corpus.reader.dependency.DependencyCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.AttrDict:3: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.doc:31: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.frame:36: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:75: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:76: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:82: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:84: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:85: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:85: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.lu:86: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.frame_relations:2: WARNING: Field list ends without a blank line; unexpected unindent.  
[sic]\nltk\corpus\reader\framenet.py:docstring of nltk.corpus.reader.framenet.FramenetCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\ieer.py:docstring of nltk.corpus.reader.ieer:6: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\ipipan.py:docstring of nltk.corpus.reader.ipipan.IPIPANCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\knbc.py:docstring of nltk.corpus.reader.knbc.KNBCorpusReader:16: WARNING: Unexpected section title.

Usage example
-------------
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.instances:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.lines:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\nombank.py:docstring of nltk.corpus.reader.nombank.NombankCorpusReader.nouns:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\nps_chat.py:docstring of nltk.corpus.reader.nps_chat.NPSChatCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\opinion_lexicon.py:docstring of nltk.corpus.reader.opinion_lexicon:4: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\opinion_lexicon.py:docstring of nltk.corpus.reader.opinion_lexicon:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.translations:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.translations:11: WARNING: Definition list ends without a blank line; unexpected 
unindent.
[sic]\nltk\corpus\reader\panlex_lite.py:docstring of nltk.corpus.reader.panlex_lite.PanLexLiteCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\panlex_swadesh.py:docstring of nltk.corpus.reader.panlex_swadesh.PanlexSwadeshCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\plaintext.py:docstring of nltk.corpus.reader.plaintext.EuroparlCorpusReader:6: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.instances:2: WARNING: Field list ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.lines:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\propbank.py:docstring of nltk.corpus.reader.propbank.PropbankCorpusReader.verbs:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\reviews.py:docstring of nltk.corpus.reader.reviews:4: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\reviews.py:docstring of nltk.corpus.reader.reviews:36: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\reviews.py:docstring of nltk.corpus.reader.reviews:38: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\semcor.py:docstring of nltk.corpus.reader.semcor.SemcorCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\switchboard.py:docstring of nltk.corpus.reader.switchboard.SwitchboardCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit:12: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.utteranceids:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.transcription_dict:2: WARNING: Field list ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\timit.py:docstring of nltk.corpus.reader.timit.TimitCorpusReader.spkrutteranceids:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.__init__:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.docs:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\twitter.py:docstring of nltk.corpus.reader.twitter.TwitterCorpusReader.tokenized:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.pprint:7: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\verbnet.py:docstring of nltk.corpus.reader.verbnet.VerbnetCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\wordlist.py:docstring of nltk.corpus.reader.wordlist.MWAPPDBCorpusReader:4: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.Synset.max_depth:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.Synset.min_depth:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_pos_and_offset:5: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:6: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:7: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:12: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:21: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.synset_from_sense_key:22: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.ic:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.custom_lemmas:9: WARNING: Field list ends without a blank line; unexpected unindent.       
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.        
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetICCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\xmldocs.py:docstring of nltk.corpus.reader.xmldocs.XMLCorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:15: WARNING: Unexpected indentation.
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\corpus\reader\ycoe.py:docstring of nltk.corpus.reader.ycoe.YCOECorpusReader.__init__:26: WARNING: Unknown target name: "tagged".
[sic]\nltk\corpus\util.py:docstring of nltk.corpus.util.LazyCorpusLoader:26: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\corpus\util.py:docstring of nltk.corpus.util.LazyCorpusLoader:27: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\draw\util.py:docstring of nltk.draw.util.CanvasWidget:57: WARNING: Unexpected indentation.
[sic]\nltk\draw\util.py:docstring of nltk.draw.util.ColorizedList:3: WARNING: Unexpected indentation.
[sic]\nltk\draw\util.py:docstring of nltk.draw.util.ColorizedList:8: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\featstruct.py:docstring of nltk.featstruct.FeatStruct.__new__:8: WARNING: Unexpected indentation.
[sic]\nltk\grammar.py:docstring of nltk.grammar.CFG.__init__:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\grammar.py:docstring of nltk.grammar.CFG.chomsky_normal_form:3: WARNING: Unexpected indentation.
[sic]\nltk\grammar.py:docstring of nltk.grammar.CFG.binarize:5: WARNING: Unexpected indentation.
[sic]\nltk\grammar.py:docstring of nltk.grammar.CFG.binarize:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\inference\api.py:docstring of nltk.inference.api.TheoremToolCommand.retract_assumptions:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\inference\api.py:docstring of nltk.inference.api.BaseTheoremToolCommand.retract_assumptions:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\inference\api.py:docstring of nltk.inference.api.TheoremToolCommandDecorator.retract_assumptions:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\inference\nonmonotonic.py:docstring of nltk.inference.nonmonotonic.ClosedDomainProver.replace_quants:6: WARNING: Definition list ends without a blank line; unexpected unindent.[sic]\nltk\inference\prover9.py:docstring of nltk.inference.prover9.Prover9Parent.prover9_input:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\inference\resolution.py:docstring of nltk.inference.resolution.Clause.unify:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\inference\resolution.py:docstring of nltk.inference.resolution.Clause.substitute_bindings:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\internals.py:docstring of nltk.internals.read_str:26: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\internals.py:docstring of nltk.internals.read_int:22: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\internals.py:docstring of nltk.internals.read_number:22: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\internals.py:docstring of nltk.internals.overridden:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.unmasked_score:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\vocabulary.py:docstring of nltk.lm.vocabulary.Vocabulary:5: WARNING: Unexpected indentation.
[sic]\nltk\lm\vocabulary.py:docstring of nltk.lm.vocabulary.Vocabulary:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\api.py:docstring of nltk.lm.api.LanguageModel.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\api.py:docstring of nltk.lm.api.LanguageModel.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\api.py:docstring of nltk.lm.api.LanguageModel.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\api.py:docstring of nltk.lm.api.LanguageModel.unmasked_score:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\api.py:docstring of nltk.lm.api.LanguageModel.generate:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Lidstone.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.Laplace.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.StupidBackoff.unmasked_score:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.InterpolatedLanguageModel.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.InterpolatedLanguageModel.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.InterpolatedLanguageModel.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.InterpolatedLanguageModel.unmasked_score:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.WittenBellInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.AbsoluteDiscountingInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\lm\models.py:docstring of nltk.lm.models.KneserNeyInterpolated.__init__:10: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\lm\preprocessing.py:docstring of nltk.lm.preprocessing.padded_everygram_pipeline:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\lm\vocabulary.py:docstring of nltk.lm.vocabulary.Vocabulary:5: WARNING: Unexpected indentation.
[sic]\nltk\lm\vocabulary.py:docstring of nltk.lm.vocabulary.Vocabulary:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\agreement.py:docstring of nltk.metrics.agreement.AnnotationTask.__init__:5: WARNING: Unexpected indentation.
[sic]\nltk\metrics\agreement.py:docstring of nltk.metrics.agreement.AnnotationTask.__init__:9: WARNING: Unexpected indentation.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.BigramAssocMeasures:11: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.BigramAssocMeasures:11: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.TrigramAssocMeasures:9: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.TrigramAssocMeasures:9: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.QuadgramAssocMeasures:10: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.QuadgramAssocMeasures:10: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\association.py:docstring of nltk.metrics.association.QuadgramAssocMeasures:10: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.edit_distance:22: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.edit_distance_align:24: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:7: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:14: WARNING: Bullet list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:16: WARNING: Unexpected indentation.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:34: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_winkler_similarity:63: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_similarity:11: WARNING: Undefined substitution referenced: "s_1".
[sic]\nltk\metrics\distance.py:docstring of nltk.metrics.distance.jaro_similarity:14: WARNING: Undefined substitution referenced: "s_i".
[sic]\nltk\metrics\paice.py:docstring of nltk.metrics.paice.get_words_from_dictionary:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\paice.py:docstring of nltk.metrics.paice.Paice.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\segmentation.py:docstring of nltk.metrics.segmentation:7: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\segmentation.py:docstring of nltk.metrics.segmentation.ghd:37: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\metrics\segmentation.py:docstring of nltk.metrics.segmentation.ghd:37: WARNING: Undefined substitution referenced: "i - j".
[sic]\nltk\misc\minimalset.py:docstring of nltk.misc.minimalset.MinimalSet.contexts:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\api.py:docstring of nltk.parse.api.ParserI.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.__init__:15: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.__init__:20: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.parse:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.tagged_parse:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.from_unified_model_dir:8: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\bllip.py:docstring of nltk.parse.bllip.BllipParser.from_unified_model_dir:13: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\chart.py:docstring of nltk.parse.chart.AbstractChartRule:5: WARNING: Inline literal start-string without end-string.
[sic]\nltk\parse\chart.py:docstring of nltk.parse.chart.ChartParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\chart.py:docstring of nltk.parse.chart.SteppingChartParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\corenlp.py:docstring of nltk.parse.corenlp.CoreNLPParser:123: WARNING: Unexpected section title.

Special cases
-------------
[sic]\nltk\parse\corenlp.py:docstring of nltk.parse.corenlp.CoreNLPDependencyParser:105: WARNING: Unexpected section title.

Special cases
-------------
[sic]\nltk\parse\dependencygraph.py:docstring of nltk.parse.dependencygraph.DependencyGraph.__init__:12: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\dependencygraph.py:docstring of nltk.parse.dependencygraph.DependencyGraph.__init__:15: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\dependencygraph.py:docstring of nltk.parse.dependencygraph.DependencyGraph.load:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\featurechart.py:docstring of nltk.parse.featurechart.FeatureSingleEdgeFundamentalRule:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\parse\featurechart.py:docstring of nltk.parse.featurechart.FeatureTopDownPredictRule:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\parse\featurechart.py:docstring of nltk.parse.featurechart.InstantiateVarsChart:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\parse\malt.py:docstring of nltk.parse.malt.MaltParser.__init__:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\malt.py:docstring of nltk.parse.malt.MaltParser.parse_tagged_sents:8: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DependencyScorerI.train:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DependencyScorerI.score:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DependencyScorerI.score:14: WARNING: Unexpected indentation.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DependencyScorerI.score:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DemoScorer.train:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DemoScorer.score:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DemoScorer.score:14: WARNING: Unexpected indentation.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.DemoScorer.score:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.ProbabilisticNonprojectiveParser:31: WARNING: Unexpected section title.

Rule based example
------------------
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.ProbabilisticNonprojectiveParser.compute_original_indexes:9: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.ProbabilisticNonprojectiveParser.compute_max_subtract_score:7: WARNING: Field list 
ends without a blank line; unexpected unindent.
[sic]\nltk\parse\nonprojectivedependencyparser.py:docstring of nltk.parse.nonprojectivedependencyparser.ProbabilisticNonprojectiveParser.best_incoming_arc:6: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\pchart.py:docstring of nltk.parse.pchart.BottomUpProbabilisticChartParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\projectivedependencyparser.py:docstring of nltk.parse.projectivedependencyparser.ProbabilisticProjectiveDependencyParser:11: WARNING: Unexpected section title.

Usage example
-------------
[sic]\nltk\parse\recursivedescent.py:docstring of nltk.parse.recursivedescent.RecursiveDescentParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\recursivedescent.py:docstring of nltk.parse.recursivedescent.SteppingRecursiveDescentParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.  
[sic]\nltk\parse\shiftreduce.py:docstring of nltk.parse.shiftreduce.ShiftReduceParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\shiftreduce.py:docstring of nltk.parse.shiftreduce.SteppingShiftReduceParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\transitionparser.py:docstring of nltk.parse.transitionparser.Transition.left_arc:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\transitionparser.py:docstring of nltk.parse.transitionparser.Transition.right_arc:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\transitionparser.py:docstring of nltk.parse.transitionparser.Transition.reduce:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\transitionparser.py:docstring of nltk.parse.transitionparser.Transition.shift:3: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\util.py:docstring of nltk.parse.util.TestGrammar.run:4: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\parse\util.py:docstring of nltk.parse.util.extract_test_sentences:3: WARNING: Unexpected indentation.
[sic]\nltk\parse\util.py:docstring of nltk.parse.util.extract_test_sentences:5: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\parse\viterbi.py:docstring of nltk.parse.viterbi.ViterbiParser.parse:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\probability.py:docstring of nltk.probability.ConditionalFreqDist.plot:1: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\probability.py:docstring of nltk.probability.ConditionalFreqDist.plot:1: WARNING: Inline strong start-string without end-string.
[sic]\nltk\probability.py:docstring of nltk.probability.FreqDist.plot:1: WARNING: Inline strong start-string without end-string.
[sic]\nltk\sem\boxer.py:docstring of nltk.sem.boxer:10: WARNING: Unexpected indentation.
[sic]\nltk\sem\boxer.py:docstring of nltk.sem.boxer.Boxer.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\boxer.py:docstring of nltk.sem.boxer.BoxerOutputDrsParser.parse:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\boxer.py:docstring of nltk.sem.boxer.BoxerDrsParser.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\chat80.py:docstring of nltk.sem.chat80.Concept.__init__:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\drt.py:docstring of nltk.sem.drt.DrtParser.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\drt.py:docstring of nltk.sem.drt.DRS.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\glue.py:docstring of nltk.sem.glue.GlueDict.get_meaning_formula:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\linearlogic.py:docstring of nltk.sem.linearlogic.LinearLogicParser.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\logic.py:docstring of nltk.sem.logic.LogicParser.__init__:2: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\logic.py:docstring of nltk.sem.logic.LogicParser.parse:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\sem\util.py:docstring of nltk.sem.util.parse_sents:8: WARNING: Inline literal start-string without end-string.
[sic]\nltk\sentiment\sentiment_analyzer.py:docstring of nltk.sentiment.sentiment_analyzer.SentimentAnalyzer.all_words:4: WARNING: Unexpected indentation.
[sic]\nltk\sentiment\sentiment_analyzer.py:docstring of nltk.sentiment.sentiment_analyzer.SentimentAnalyzer.all_words:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\sentiment\util.py:docstring of nltk.sentiment.util.demo_tweets:4: WARNING: Unexpected indentation.
[sic]\nltk\sentiment\util.py:docstring of nltk.sentiment.util.demo_movie_reviews:5: WARNING: Unexpected indentation.
[sic]\nltk\stem\porter.py:docstring of nltk.stem.porter.PorterStemmer:33: WARNING: Unexpected indentation.
[sic]\nltk\stem\porter.py:docstring of nltk.stem.porter.PorterStemmer:39: WARNING: Unexpected indentation.
[sic]\nltk\stem\snowball.py:docstring of nltk.stem.snowball.ArabicStemmer:4: WARNING: Unexpected indentation.
[sic]\nltk\stem\snowball.py:docstring of nltk.stem.snowball.ArabicStemmer:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\stem\snowball.py:docstring of nltk.stem.snowball.ArabicStemmer.stem:2: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\stem\util.py:docstring of nltk.stem.util.prefix_replace:2: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tag\brill_trainer.py:docstring of nltk.tag.brill_trainer.BrillTaggerTrainer.train:100: WARNING: Unexpected indentation.
[sic]\nltk\tag\brill_trainer.py:docstring of nltk.tag.brill_trainer.BrillTaggerTrainer.train:101: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tag\brill_trainer.py:docstring of nltk.tag.brill_trainer.BrillTaggerTrainer.train:103: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.__init__:21: WARNING: Unexpected indentation.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.__init__:22: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.__init__:26: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.__init__:27: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag_sents:2: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag_sents:3: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag_sents:4: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag:2: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag:3: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tag\crf.py:docstring of nltk.tag.crf.CRFTagger.tag:4: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\tag\perceptron.py:docstring of nltk.tag.perceptron.PerceptronTagger:3: WARNING: Unexpected indentation.
[sic]\nltk\tag\senna.py:docstring of nltk.tag.senna:5: WARNING: Unexpected indentation.
[sic]\nltk\tag\senna.py:docstring of nltk.tag.senna:6: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tag\tnt.py:docstring of nltk.tag.tnt.TnT.__init__:5: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.__init__:22: WARNING: Unexpected indentation.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.__init__:24: WARNING: Unexpected indentation.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.__init__:25: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.expand:34: WARNING: Unexpected indentation.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.expand:36: WARNING: Unexpected indentation.
[sic]\nltk\tbl\feature.py:docstring of nltk.tbl.feature.Feature.expand:37: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tbl\rule.py:docstring of nltk.tbl.rule.Rule:14: WARNING: Unexpected indentation.
[sic]\nltk\tbl\rule.py:docstring of nltk.tbl.rule.Rule.__init__:7: WARNING: Unexpected indentation.
[sic]\nltk\tbl\rule.py:docstring of nltk.tbl.rule.Rule.__init__:11: WARNING: Unexpected indentation.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.BrillTemplateI.applicable_rules:1: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.BrillTemplateI.applicable_rules:6: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.BrillTemplateI.applicable_rules:14: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.__init__:41: WARNING: Unexpected indentation.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.__init__:43: WARNING: Unexpected indentation.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.__init__:44: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.applicable_rules:1: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.applicable_rules:6: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\tbl\template.py:docstring of nltk.tbl.template.Template.applicable_rules:14: WARNING: Inline emphasis start-string without end-string.
[sic]\nltk\test\unit\test_distance.py:docstring of nltk.test.unit.test_distance.TestEditDistance.test_with_transpositions:9: WARNING: Unexpected indentation.
[sic]\nltk\test\unit\test_stem.py:docstring of nltk.test.unit.test_stem.PorterTest.test_vocabulary_martin_mode:6: WARNING: Definition list ends without a blank line; unexpected unindent. 
[sic]\nltk\test\unit\test_stem.py:docstring of nltk.test.unit.test_stem.PorterTest.test_vocabulary_martin_mode:8: WARNING: Unexpected indentation.
[sic]\nltk\text.py:docstring of nltk.text.Text.generate:11: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:1: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:8: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:8: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:24: WARNING: Unexpected indentation.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:25: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:25: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\legality_principle.py:docstring of nltk.tokenize.legality_principle:26: WARNING: Inline literal start-string without end-string.
[sic]\nltk\tokenize\sonority_sequencing.py:docstring of nltk.tokenize.sonority_sequencing:17: WARNING: Unexpected indentation.
[sic]\nltk\tokenize\sonority_sequencing.py:docstring of nltk.tokenize.sonority_sequencing:18: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\tokenize\treebank.py:docstring of nltk.tokenize.treebank.TreebankWordDetokenizer:6: WARNING: Unexpected indentation.
[sic]\nltk\tokenize\treebank.py:docstring of nltk.tokenize.treebank.TreebankWordDetokenizer:7: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\bleu_score.py:docstring of nltk.translate.bleu_score.brevity_penalty:74: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\bleu_score.py:docstring of nltk.translate.bleu_score.SmoothingFunction.method3:6: WARNING: Unexpected indentation.
[sic]\nltk\translate\bleu_score.py:docstring of nltk.translate.bleu_score.SmoothingFunction.method3:8: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm1.py:docstring of nltk.translate.ibm1:25: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm1.py:docstring of nltk.translate.ibm1:34: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm1.py:docstring of nltk.translate.ibm1:35: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm1.py:docstring of nltk.translate.ibm1:37: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:9: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:11: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:12: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:21: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:22: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm2.py:docstring of nltk.translate.ibm2:24: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:24: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:26: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:27: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:44: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:45: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:47: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:53: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm3.py:docstring of nltk.translate.ibm3:54: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:18: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:20: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:42: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:45: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:50: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:52: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:53: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:71: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:72: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:74: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:80: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm4.py:docstring of nltk.translate.ibm4:81: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:25: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:33: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:43: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:44: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:46: WARNING: Enumerated list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:50: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:52: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:53: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:56: WARNING: Enumerated list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:59: WARNING: Enumerated list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:72: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:73: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:75: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:81: WARNING: Unexpected indentation.
[sic]\nltk\translate\ibm5.py:docstring of nltk.translate.ibm5:82: WARNING: Block quote ends without a blank line; unexpected unindent.
[sic]\nltk\translate\stack_decoder.py:docstring of nltk.translate.stack_decoder.StackDecoder.compute_future_scores:10: WARNING: Field list ends without a blank line; unexpected unindent. 
[sic]\nltk\twitter\common.py:docstring of nltk.twitter.common:1: WARNING: Unknown interpreted text role "module".
[sic]\nltk\twitter\common.py:docstring of nltk.twitter.common.json2csv_entities:16: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitter_demo.py:docstring of nltk.twitter.twitter_demo.corpusreader_demo:1: WARNING: Unknown interpreted text role "module".
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Query.__init__:7: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Query.__init__:20: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Query.__init__:24: WARNING: Definition list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Query.__init__:25: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Query.__init__:28: WARNING: Unexpected indentation.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Twitter.tweets:12: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\twitterclient.py:docstring of nltk.twitter.twitterclient.Twitter.tweets:17: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\nltk\twitter\util.py:docstring of nltk.twitter.util:1: WARNING: Unknown interpreted text role "module".
[sic]\nltk\twitter\util.py:docstring of nltk.twitter.util.Authenticate.load_creds:5: WARNING: Unexpected section title.

File format for OAuth 1
=======================
[sic]\nltk\twitter\util.py:docstring of nltk.twitter.util.Authenticate.load_creds:14: WARNING: Unexpected section title.

File format for OAuth 2
=======================
[sic]\nltk\util.py:docstring of nltk.util.edges2dot:4: WARNING: Field list ends without a blank line; unexpected unindent.
[sic]\web\news.rst:2: WARNING: Duplicate explicit target name: "here".
[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.ic:: WARNING: more than one target found for cross-reference 'CorpusReader': nltk.corpus.reader.CorpusReader, nltk.corpus.reader.api.CorpusReader
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.process_thread:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.process_thread:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.combine_readings:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.combine_readings:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.to_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.to_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.DiscourseTester.__init__:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.DiscourseTester.multiply:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.load_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\sem\evaluate.py:docstring of nltk.sem.evaluate.Model.satisfiers:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression

The issue

Some of these warnings didn't mean much - Sphinx could still understand everything, and the only effect on the website was some more or less whitespace somewhere. However, in some situations the warnings were indeed indicative of some big issues with the generated site. This is an issue that has existed since that documentation was written, and is simply because the in-code docstrings were not proper ReST.

Some examples

The differences between old and new range from small to substantial. Here's some examples:

old new
old new
old new
old new
old new

Remaining warnings

This PR has reduced the number of warnings from ~516 to 11, as these warnings still exist:

[sic]\nltk\corpus\reader\wordnet.py:docstring of nltk.corpus.reader.wordnet.WordNetCorpusReader.ic:: WARNING: more than one target found for cross-reference 'CorpusReader': nltk.corpus.reader.CorpusReader, nltk.corpus.reader.api.CorpusReader
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.process_thread:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.process_thread:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.combine_readings:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.combine_readings:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.to_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.ReadingCommand.to_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.DiscourseTester.__init__:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.DiscourseTester.multiply:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\inference\discourse.py:docstring of nltk.inference.discourse.load_fol:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression
[sic]\nltk\sem\evaluate.py:docstring of nltk.sem.evaluate.Model.satisfiers:: WARNING: more than one target found for cross-reference 'Expression': nltk.sem.linearlogic.Expression, nltk.sem.logic.Expression

These warnings are all related to how Sphinx finds multiple sources for some terms. These can cause issues, as Expression might become a clickable link to the wrong class called Expression on the website. This is something that ought to be handled at some point.

Formatting issue with news.html

One tiny error I found while going through the website was that there's no space inbetween released and the date from roughly 2015 backwards on NLTK's news page: https://www.nltk.org/news.html#id7
Also see this screenshot:
image

This was due to the separated colon here: NLTK 3.2 released : March 2016. I've now replaced this with NLTK 3.2 released: March 2016 in commit 1b57208. Feel free to compare the results by going to https://tomaarsen.com/nltk/news.html#id7. The result can also be seen in this screenshot.
image

Note

The website formatting is still far from perfect. I've only fixed the cases that were so wrong that they threw warnings or errors. There's probably many, many more places where the formatting simply isn't like intended or desired.
That said, I believe this PR will make some more steps in making our documentation a useful resource once more.

  • Tom Aarsen

tomaarsen added a commit to tomaarsen/nltk.github.com that referenced this issue Oct 18, 2021
@stevenbird stevenbird merged commit 4a130f1 into nltk:develop Oct 19, 2021
16 checks passed
@stevenbird
Copy link
Member

@stevenbird stevenbird commented Oct 19, 2021

@tomaarsen Wonderful!

@stevenbird
Copy link
Member

@stevenbird stevenbird commented Oct 19, 2021

Deployed in nltk/nltk.github.com@b899400

@tomaarsen tomaarsen deleted the enhancement/documentation-warnings branch Oct 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants