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

Identical ad hoc sections in multiple files result in duplication #8

Closed
nilnor opened this issue Jan 19, 2012 · 2 comments
Closed

Identical ad hoc sections in multiple files result in duplication #8

nilnor opened this issue Jan 19, 2012 · 2 comments

Comments

@nilnor
Copy link
Contributor

nilnor commented Jan 19, 2012

I'm using (abusing?) ad hoc sections for documenting class instance variables, like so:

--- Instance fields. These can be set only for an buffer instance, and not
-- globally for the module.
-- @section instance

--- foo is bar,  blah blah
foo = nil

--- @section end

This worked fine for the first file, but when doing the same for a second file in the module this results in duplicated documentation for the contained fields (e.g. for the example above you get two "Instance fields" headers each containing the same duplicate documentation for foo. Some investigation reveals that it's having the same deduced section name ("Instance fields" in this case) which caused the issue, and that renaming it for one of the files avoid the issue.

This is for master.

artembo referenced this issue in tarantool/LDoc Mar 16, 2020
* WIP: rst output initial

* WIP: rst output split html and rst

* plain descriptions and independent output generators

* local links is temporary highlighted, not working as links now

* fix some broken links and rst template

* fix some broken links and rst template

* description markup update
got rid of rem_enters
general markup improvements

* Flag without_source added

If you need to exclude any source checking, set this flag

example config.ld:

```lua

without_source = true

topics = {
    "README.md",
    "CHANGELOG.md"
}

format = 'markdown'
```

* Fixed behavior

* added fourth level header

* Allow to use any language in code-blocks or don't specify the language
Fixes: #4

* Convert markdown to .rst nested lists
The solution works for the second level lists only
Closes: #3

* Added "+" "-" "*" to bullet lists and first level numbered lists support
#3

* Added toctree caption text with --toctree argument

* Build rst output for module descriptions

* format Usage as rst lua code-block

* format Usage as rst lua code-block fix indent

* format Usage as rst lua code-block fix indent

* add run-rst-tests script

* Add annotation tests

* CI (#8)

* Add .travis.yml

* readme: add usage and tests description

* add native tests

Co-authored-by: Ivan Naidenov <vanyarock01@gmail.com>
Co-authored-by: Ryazanov Maxim <34471120+RyazMax@users.noreply.github.com>
@alerque
Copy link
Member

alerque commented May 3, 2023

The handling of multiple modules in one file has changed and supported in v1.5.0. I'm really struggling to see the use cane for having namespace clashes with identical sections coming from multiple files. I think that puts this in the "won't implement" category, but I'm willing to reconsider if you (or anybody) can layout a use case for it a little more clearly. If there really isn't a better way to accomplish what needs to be done we can re-open this and figure out how to address it.

@alerque alerque closed this as not planned Won't fix, can't repro, duplicate, stale May 3, 2023
@alerque
Copy link
Member

alerque commented May 3, 2023

@artembo Please do open a PR if you have something to contribute towards this, perhaps with some example code it would be more clear what the use case is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants