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

Implement special ditto documentation handling #111

Merged
merged 2 commits into from
Dec 29, 2018

Conversation

WebFreak001
Copy link
Member

Stores ditto documentation using their actual documentation and has a special ditto flag on the documentation strings.

This is not backwards compatible with any code relying on documentation being "ditto" instead of the actual documentation, otherwise it's backwards compatible.

Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look reasonable, maybe try to see about the two comments.
Also current DCD output in non-extended mode won't be modified if i understand correctly ?

src/dsymbol/conversion/first.d Outdated Show resolved Hide resolved
src/dsymbol/symbol.d Show resolved Hide resolved
@WebFreak001
Copy link
Member Author

WebFreak001 commented Dec 29, 2018

current non-extended mode should not notably get modified.

The current code is compatible with current tests, but I'm further extending it to also test ditto scopes. where I already found an issue

I think before this implementation there might have been an issue if a ditto was used on a function with different name as the one you are trying to test, which should now work just as the D compiler.

@WebFreak001
Copy link
Member Author

WebFreak001 commented Dec 29, 2018

The current code passes with all the tests in DCD (also using the example from the D ddoc spec) with ditto scopes.

For adding it in DCD we need a new tagged version of this after this is merged.

@ghost ghost added the auto-merge-squash label Dec 29, 2018
@dlang-bot dlang-bot merged commit 913e1f1 into dlang-community:master Dec 29, 2018
@ghost
Copy link

ghost commented Dec 29, 2018

I let you put the appropriated tag yourself.

@WebFreak001
Copy link
Member Author

should I do just a tag or use the "draft a release" button?

@ghost
Copy link

ghost commented Dec 29, 2018

just a tag is enough since this is a low level library people usually don't care about having a nice changelog.

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.

2 participants